Send SMS

API Docs by APIMATIC

Send SMS
#

  • REST
  • Java

Send SMS
#

Enables agents to send SMS messages via the API. Agents are identified by their extensions (agent parameter). The destination numbers are specified in the number parameter.

POST /api/v1/{api_key}/sendsms

API Code Playground

Endpoint Arguments
Parameters
Required
Required
String
Template
Required
application/json
Required
Number
Form

Agent extension

Required
String
Form

Destination phone number

Required
String
Form

SMS body. 1-1600 chars. Links are not supported in SMS

String
Form

Your call center SenderID. If this field is empty, a random SenderID from the 'Default' group is used. The request fails if you have no SenderIDs configured

String
Form

Name of sending application or CRM

String
Form

The CRM Account ID for the contact at the destination number. This parameter may also be used when you specify the crm parameter.


Responses

  • 200
  • 400
  • 403

All parameters are valid and the SMS sending is successful.

application/json

{
  "sms_id": "ab52fd83-770c-4069-aaee-x951139x9xf6",
  "segments": 1
}
  • Request
  • Response
curl -X POST \
  --url 'https://{cluster_id}.voiso.com/api/v1/%7Bcontact_center_api_key%7D/sendsms'  \
  -H 'Accept: application/json'\
  -d 'agent=102' \
  -d 'number=number2' \
  -d 'body=body6'