SMS Integration APIs: Overview
X‑Platform provides a set of APIs to support creation and management of SMS Campaigns, enabling you to direct a customer to specific Flows using predefined text messages and links.
Note
For more information about campaigns, refer to SMS Campaign Overview.
SMS Campaign API methods include:
Carrier Lookup API: Returns data about a given phone number, such as whether it is a landline or a mobile device. This method is used to determine if it is possible to send an SMS containing an Interaction access link to a customer's phone.
Send SMS API: Sends the text message defined in a campaign SMS to a customer's mobile device, using the Uniphore internal SMS gateway.
Get Interaction Link API: Returns the Interaction access link that is created for a specific campaign. This method is intended for use by customers who have independent SMS gateways.
Notification Only APIs: The Notify Carrier Lookup and Notify SMS API methods are invoked only when an external SMS provider is being used. For more information, contact your Uniphore Support representative.