Rate this page:

SMSInterface

Props

a2PGetSmsHistory: (request: A2PGetSmsHistoryRequest) => Promise<A2PGetSmsHistoryResponse>

Gets the history of sent/or received A2P SMS.

a2PSendSms: (request: A2PSendSmsRequest) => Promise<A2PSendSmsResponse>

Sends an SMS message from the application to customers. The source phone number should be purchased from Voximplant and support SMS (which is indicated by the is_sms_supported property in the objects returned by the /GetPhoneNumbers Management API) and SMS should be enabled for it via the /ControlSms Management API.

controlSms: (request: ControlSmsRequest) => Promise<ControlSmsResponse>

Enables or disables sending and receiving SMS for the phone number. Can be used only for phone numbers with SMS support, which is indicated by the is_sms_supported property in the objects returned by the Management API. Each incoming SMS message is charged according to the pricing. If enabled, SMS can be sent from this phone number via the Management API and received via the property of the HTTP callback. See this article for HTTP callback details.

getSmsHistory: (request: GetSmsHistoryRequest) => Promise<GetSmsHistoryResponse>

Gets the history of sent and/or received SMS.

sendSmsMessage: (request: SendSmsMessageRequest) => Promise<SendSmsMessageResponse>

Sends an SMS message between two phone numbers. The source phone number should be purchased from Voximplant and support SMS (which is indicated by the is_sms_supported property in the objects returned by the Management API) and SMS should be enabled for it via the Management API. SMS messages can be received via HTTP callbacks, see this article for details.