SMS/MMS Messaging

The SMS/MMS API allows sending SMS/MMS messages via text-capable access numbers of the BP platform from an external application and tracking the delivery status of those messages.

This document describes how to get started with developing with SMS and MMS on OneCloud CX, the methods used can be found at Send Message, with example requests and responses. You can alternatively load this API into the Postman API Development Environment to interact with the API with your own access tokens.

Note the following:

The user account used for authentication of the SMS/MMS API requests must have privilege Use SMS/MMS API.

A 200 OK response to a Send Message request will always show the message status as "queued". Actual status of message delivery can be verified using the Get Message method with a slight delay

Note that in the current version, the only records created in BPCC for the SMS messages sent via this API will be records in the Carrier Usage reports.

Possible replies to the messages sent via the API can be directed to a chat service associated with the access number used as the sender ID (field From:) in the Send Message request. If it is important that you receive and process possible replies, consider sending your SMS messages within the service hours and stop sending them well in advance of service closure.

If an SMS reply still comes outside of the service hours, you can configure your scenario to:

Using the Send Message+ scenario block to send an automatic reply advising the customer of the service hours.

Copy the content of the message to an Email scenario block and send this email to someone who can follow up the next day.

These methods enable sending of SMS and MMS messages and checking the delivery status. The response parameters are explained below.

Response parameters

Parameter	Description
tenant_id	Unique identifier of your contact center in BPCC configuraiton.
api_version	API version.
body	Text of the message.
num_segments	Number of segments in the transmitted message. Messages exceeding 160 characters are transmitted in multiple segements. In the current verison of API this parameters is always set to 1.
num_media	Number of media files in the MMS message.
date_created	Timestamp of the original Send Message request.
date_sent	Timestamp of message transmission. Set to "null" in responses to Send Message requests. Set to actual time when the message was sent in responses to Get Message requests.
date_updated	Reserved.
direction	Always set to outboound-api.
error_code	Error code.
error_message	Error message.
from	Origination number.
price	Reserved. In the current version of the API always set to null.
sid	Unique identifier of the message. Retured in response to a Send Message request and can be used in Get Message to check the delivery status of the message.
status	Status of message delivery. Possible values: queued (message queued to be sent), sent (message sent to SMS/MMS service provider but delivery not confirmed), delivered (message confirmed by SMS service provider to be delivered; currently not available for MMS), failed (message could not be sent; typically more details will be provided in error_message). Note that a 200 OK response to a Send Message request will always have status set to queued. Actual status of message delivery can be verified using the Get Message method with a slight delay.
to	Destination nubmer.
uri	Reserved.