陌讯skills聚合平台

telnyx-messaging-java

📁 team-telnyx/telnyx-ext-agent-skills 📅 3 days ago
3
总安装量
3
周安装量
#55721
全站排名
安装命令
npx skills add https://github.com/team-telnyx/telnyx-ext-agent-skills --skill telnyx-messaging-java

Agent 安装分布

opencode 3
antigravity 3
claude-code 3
github-copilot 3
windsurf 3
codex 3

Skill 文档

Telnyx Messaging – Java

Installation

// See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup

Setup

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();

All examples below assume client is already initialized as shown above.

Send a message

Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.

POST /messages — Required: to

Optional: auto_detect (boolean), encoding (enum), from (string), media_urls (array[string]), messaging_profile_id (string), send_at (date-time), subject (string), text (string), type (enum), use_profile_webhooks (boolean), webhook_failover_url (url), webhook_url (url)

import com.telnyx.sdk.models.messages.MessageSendParams;
import com.telnyx.sdk.models.messages.MessageSendResponse;

MessageSendParams params = MessageSendParams.builder()
    .to("+18445550001")
    .build();
MessageSendResponse response = client.messages().send(params);

Retrieve a message

Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation.

GET /messages/{id}

import com.telnyx.sdk.models.messages.MessageRetrieveParams;
import com.telnyx.sdk.models.messages.MessageRetrieveResponse;

MessageRetrieveResponse message = client.messages().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Cancel a scheduled message

Cancel a scheduled message that has not yet been sent.

DELETE /messages/{id}

import com.telnyx.sdk.models.messages.MessageCancelScheduledParams;
import com.telnyx.sdk.models.messages.MessageCancelScheduledResponse;

MessageCancelScheduledResponse response = client.messages().cancelScheduled("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

Send a Whatsapp message

POST /messages/whatsapp — Required: from, to, whatsapp_message

Optional: type (enum), webhook_url (url)

import com.telnyx.sdk.models.messages.MessageSendWhatsappParams;
import com.telnyx.sdk.models.messages.MessageSendWhatsappResponse;

MessageSendWhatsappParams params = MessageSendWhatsappParams.builder()
    .from("+13125551234")
    .to("+13125551234")
    .whatsappMessage(MessageSendWhatsappParams.WhatsappMessage.builder().build())
    .build();
MessageSendWhatsappResponse response = client.messages().sendWhatsapp(params);

Send a group MMS message

POST /messages/group_mms — Required: from, to

Optional: media_urls (array[string]), subject (string), text (string), use_profile_webhooks (boolean), webhook_failover_url (url), webhook_url (url)

import com.telnyx.sdk.models.messages.MessageSendGroupMmsParams;
import com.telnyx.sdk.models.messages.MessageSendGroupMmsResponse;

MessageSendGroupMmsParams params = MessageSendGroupMmsParams.builder()
    .from("+13125551234")
    .addTo("+18655551234")
    .addTo("+14155551234")
    .build();
MessageSendGroupMmsResponse response = client.messages().sendGroupMms(params);

Send a long code message

POST /messages/long_code — Required: from, to

Optional: auto_detect (boolean), encoding (enum), media_urls (array[string]), subject (string), text (string), type (enum), use_profile_webhooks (boolean), webhook_failover_url (url), webhook_url (url)

import com.telnyx.sdk.models.messages.MessageSendLongCodeParams;
import com.telnyx.sdk.models.messages.MessageSendLongCodeResponse;

MessageSendLongCodeParams params = MessageSendLongCodeParams.builder()
    .from("+18445550001")
    .to("+13125550002")
    .build();
MessageSendLongCodeResponse response = client.messages().sendLongCode(params);

Send a message using number pool

POST /messages/number_pool — Required: to, messaging_profile_id

Optional: auto_detect (boolean), encoding (enum), media_urls (array[string]), subject (string), text (string), type (enum), use_profile_webhooks (boolean), webhook_failover_url (url), webhook_url (url)

import com.telnyx.sdk.models.messages.MessageSendNumberPoolParams;
import com.telnyx.sdk.models.messages.MessageSendNumberPoolResponse;

MessageSendNumberPoolParams params = MessageSendNumberPoolParams.builder()
    .messagingProfileId("abc85f64-5717-4562-b3fc-2c9600000000")
    .to("+13125550002")
    .build();
MessageSendNumberPoolResponse response = client.messages().sendNumberPool(params);

Schedule a message

Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.

POST /messages/schedule — Required: to

Optional: auto_detect (boolean), from (string), media_urls (array[string]), messaging_profile_id (string), send_at (date-time), subject (string), text (string), type (enum), use_profile_webhooks (boolean), webhook_failover_url (url), webhook_url (url)

import com.telnyx.sdk.models.messages.MessageScheduleParams;
import com.telnyx.sdk.models.messages.MessageScheduleResponse;

MessageScheduleParams params = MessageScheduleParams.builder()
    .to("+18445550001")
    .build();
MessageScheduleResponse response = client.messages().schedule(params);

Send a short code message

POST /messages/short_code — Required: from, to

Optional: auto_detect (boolean), encoding (enum), media_urls (array[string]), subject (string), text (string), type (enum), use_profile_webhooks (boolean), webhook_failover_url (url), webhook_url (url)

import com.telnyx.sdk.models.messages.MessageSendShortCodeParams;
import com.telnyx.sdk.models.messages.MessageSendShortCodeResponse;

MessageSendShortCodeParams params = MessageSendShortCodeParams.builder()
    .from("+18445550001")
    .to("+18445550001")
    .build();
MessageSendShortCodeResponse response = client.messages().sendShortCode(params);

List opt-outs

Retrieve a list of opt-out blocks.

GET /messaging_optouts

import com.telnyx.sdk.models.messagingoptouts.MessagingOptoutListPage;
import com.telnyx.sdk.models.messagingoptouts.MessagingOptoutListParams;

MessagingOptoutListPage page = client.messagingOptouts().list();

Retrieve a phone number with messaging settings

GET /phone_numbers/{id}/messaging

import com.telnyx.sdk.models.phonenumbers.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.phoneNumbers().messaging().retrieve("id");

Update the messaging profile and/or messaging product of a phone number

PATCH /phone_numbers/{id}/messaging

Optional: messaging_product (string), messaging_profile_id (string), tags (array[string])

import com.telnyx.sdk.models.phonenumbers.messaging.MessagingUpdateParams;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingUpdateResponse;

MessagingUpdateResponse messaging = client.phoneNumbers().messaging().update("id");

List phone numbers with messaging settings

GET /phone_numbers/messaging

import com.telnyx.sdk.models.phonenumbers.messaging.MessagingListPage;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingListParams;

MessagingListPage page = client.phoneNumbers().messaging().list();

Retrieve a mobile phone number with messaging settings

GET /mobile_phone_numbers/{id}/messaging

import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.mobilePhoneNumbers().messaging().retrieve("id");

List mobile phone numbers with messaging settings

GET /mobile_phone_numbers/messaging

import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingListPage;
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingListParams;

MessagingListPage page = client.mobilePhoneNumbers().messaging().list();

Bulk update phone number profiles

POST /messaging_numbers/bulk_updates — Required: messaging_profile_id, numbers

Optional: assign_only (boolean)

import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateResponse;
import java.util.List;

MessagingNumbersBulkUpdateCreateParams params = MessagingNumbersBulkUpdateCreateParams.builder()
    .messagingProfileId("00000000-0000-0000-0000-000000000000")
    .numbers(List.of(
      "+18880000000",
      "+18880000001",
      "+18880000002"
    ))
    .build();
MessagingNumbersBulkUpdateCreateResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().create(params);

Retrieve bulk update status

GET /messaging_numbers/bulk_updates/{order_id}

import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveResponse;

MessagingNumbersBulkUpdateRetrieveResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().retrieve("order_id");

Webhooks

The following webhook events are sent to your configured webhook URL. All webhooks include telnyx-timestamp and telnyx-signature-ed25519 headers for verification (Standard Webhooks compatible).

Event Description
deliveryUpdate Delivery Update
inboundMessage Inbound Message
replacedLinkClick Replaced Link Click

Webhook payload fields

deliveryUpdate

Field Type Description
data.record_type enum Identifies the type of the resource.
data.id uuid Identifies the type of resource.
data.event_type enum The type of event being delivered.
data.occurred_at date-time ISO 8601 formatted date indicating when the resource was created.
data.payload.record_type enum Identifies the type of the resource.
data.payload.direction enum The direction of the message.
data.payload.id uuid Identifies the type of resource.
data.payload.type enum The type of message.
data.payload.messaging_profile_id string Unique identifier for a messaging profile.
data.payload.organization_id uuid The id of the organization the messaging profile belongs to.
data.payload.to array[object]
data.payload.cc array[object]
data.payload.text string Message body (i.e., content) as a non-empty string.
data.payload.subject [‘string’, ‘null’] Subject of multimedia message
data.payload.media array[object]
data.payload.webhook_url url The URL where webhooks related to this message will be sent.
data.payload.webhook_failover_url url The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
data.payload.encoding string Encoding scheme used for the message body.
data.payload.parts integer Number of parts into which the message’s body must be split.
data.payload.tags array[string] Tags associated with the resource.
data.payload.cost [‘object’, ‘null’]
data.payload.cost_breakdown [‘object’, ‘null’] Detailed breakdown of the message cost components.
data.payload.tcr_campaign_id [‘string’, ‘null’] The Campaign Registry (TCR) campaign ID associated with the message.
data.payload.tcr_campaign_billable boolean Indicates whether the TCR campaign is billable.
data.payload.tcr_campaign_registered [‘string’, ‘null’] The registration status of the TCR campaign.
data.payload.received_at date-time ISO 8601 formatted date indicating when the message request was received.
data.payload.sent_at date-time ISO 8601 formatted date indicating when the message was sent.
data.payload.completed_at date-time ISO 8601 formatted date indicating when the message was finalized.
data.payload.valid_until date-time Message must be out of the queue by this time or else it will be discarded and marked as ‘sending_failed’.
data.payload.errors array[object] These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.
data.payload.smart_encoding_applied boolean Indicates whether smart encoding was applied to this message.
meta.attempt integer Number of attempts to deliver the webhook event.
meta.delivered_to url The webhook URL the event was delivered to.

inboundMessage

Field Type Description
data.record_type enum Identifies the type of the resource.
data.id uuid Identifies the type of resource.
data.event_type enum The type of event being delivered.
data.occurred_at date-time ISO 8601 formatted date indicating when the resource was created.
data.payload.record_type enum Identifies the type of the resource.
data.payload.direction enum The direction of the message.
data.payload.id uuid Identifies the type of resource.
data.payload.type enum The type of message.
data.payload.messaging_profile_id string Unique identifier for a messaging profile.
data.payload.organization_id string Unique identifier for a messaging profile.
data.payload.to array[object]
data.payload.cc array[object]
data.payload.text string Message body (i.e., content) as a non-empty string.
data.payload.subject [‘string’, ‘null’] Message subject.
data.payload.media array[object]
data.payload.webhook_url url The URL where webhooks related to this message will be sent.
data.payload.webhook_failover_url url The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
data.payload.encoding string Encoding scheme used for the message body.
data.payload.parts integer Number of parts into which the message’s body must be split.
data.payload.tags array[string] Tags associated with the resource.
data.payload.cost [‘object’, ‘null’]
data.payload.cost_breakdown [‘object’, ‘null’] Detailed breakdown of the message cost components.
data.payload.tcr_campaign_id [‘string’, ‘null’] The Campaign Registry (TCR) campaign ID associated with the message.
data.payload.tcr_campaign_billable boolean Indicates whether the TCR campaign is billable.
data.payload.tcr_campaign_registered [‘string’, ‘null’] The registration status of the TCR campaign.
data.payload.received_at date-time ISO 8601 formatted date indicating when the message request was received.
data.payload.sent_at date-time Not used for inbound messages.
data.payload.completed_at date-time Not used for inbound messages.
data.payload.valid_until date-time Not used for inbound messages.
data.payload.errors array[object] These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.

replacedLinkClick

Field Type Description
data.record_type string Identifies the type of the resource.
data.url string The original link that was sent in the message.
data.to string Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
data.message_id uuid The message ID associated with the clicked link.
data.time_clicked date-time ISO 8601 formatted date indicating when the message request was received.
GitHub 仓库 ↗ ← 返回陌讯 Skills 聚合平台
本页面由 陌讯 Skills 聚合平台 收录整理，数据定期更新。