Platform DocumentationPlatform ChangelogAPI ReferencePush & In-App SDKsSDK Release Notes
API Reference
FAQsWebsite

Send an SMS message to a mobile device

post
https://api-sandbox.imiconnect.io/v1/sms/messages

šŸ“˜

Note:

  • New Sandbox API endpoint: https://api.us.webexconnect.io/v1/sms/messages
  • The sandbox limits you to only sending messages to your verified phone number(s). You can register up to 5 phone numbers (all belonging to the same country) for sending and receiving test messages.
Body Params
string
required

Short or long code that the message should be sent from

string
required

The mobile device phone number in E.164 format that should receive the message

string
required
length ā‰¤ 1024

Text message content or template ID to be used to send to the mobile device

string
enum
Defaults to TEXT

Denotes whether the content string is the actual text content to be sent or a reference to a template ID.

Allowed:
substitutions
object

Members of this object are used to replace placeholders within the content or template specified.

string

User defined ID that is assigned to an individual message

string

Specifies the DLT template ID used for this message. This is only used in certain regions.

string

If provided, events related to the delivery of this message will be POSTed to this URL.

string

Additional data that will be echoed back in all callback requests made to callbackUrl

string

If the message has not been sent by this date & time, it will be removed from the sending queue

Headers
string
required
length ā‰¤ 64

An optional user provided value that is used to prevent duplicate requests. API requests with an Idempotency-Key value that has been used in the previous 1 hours will be rejected as a duplicate request.

Responses

Callback

Updated 3 months ago

Language
Credentials
Bearer
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago