RIringcentral
SMS

Send SMS

Creates and sends a new text message or multiple messages. You can send SMS messages simultaneously to different recipients up to 40 requests per minute; this limitation is relevant for all client applications. Sending and receiving SMS is available for Toll-Free Numbers within the USA. You can send up to 10 attachments in a single MMS message; the size of all attachments linked is limited up to 1500000 bytes.

post/restapi/v1.0/account/{accountId}/extension/{extensionId}/sms

Request

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Request body

textstring required

Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols

Response

Message information

idinteger

Internal identifier of a message

uristring uri

Canonical URI of a message

availability'Alive' | 'Deleted' | 'Purged'

Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly

conversationIdinteger

SMS and Pager only. Identifier of a conversation that the message belongs to

creationTimestring date-time

Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z

deliveryErrorCodestring

SMS only. Delivery error code returned by gateway

direction'Inbound' | 'Outbound'

Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound

lastModifiedTimestring date-time

Date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z

messageStatus'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received'

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outbound message, a status for at least one recipient is 'Queued', then the 'Queued' value is returned. If a status for at least one recipient is 'SendingFailed', then the 'SendingFailed' value is returned. In other cases the 'Sent' status is returned

priority'Normal' | 'High'

Message priority

readStatus'Read' | 'Unread'

Message read status

smsDeliveryTimestring date-time

SMS only. The date/time when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral

smsSendingAttemptsCountinteger

SMS only. Number of attempts made to send an outbound SMS to the Gateway (if Gateway is temporary unavailable)

subjectstring

Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment

type'Fax' | 'SMS' | 'VoiceMail' | 'Pager' | 'Text'

Message type

Changes

No recorded changes to this operation across all 1 revision of this API.