POST - Send SMS v2 version 
 

Purpose

Use this API to send sms, mms and templates.
 

Note

MMS and Templates are only available in this v2 version


Authorization

HeaderKey

Description

Authorization*

Zoho-oauthtoken<space><ACCESS_TOKEN>

Accept*

Set to application/json.

Request URL

Method: POST

https://voice.zoho.com/rest/json/v2/sms/send

Scope: ZohoVoice.sms.CREATE

Parameters: 

Param Name

Data Type

Description

mms_media

File (multipart/form-data)

Represents the file to be uploaded to the server using multipart/form-data.

sms_data *

JSON

Represents the SMS data in JSON format.

 

Example:

{
"customerNumber": "18*******57",
"message": "send",
"senderId": "14********09",
"mms": true | false
}

templateId

Long

Represents the ID of the template retrieved from the Get Template API.

scheduledTime

String

Represents the scheduled time for message delivery in yyyy-mm-dd HH:MM:ss format.

timeZone

String

Represents the timezone used to schedule message delivery.

 

Example: Asia/Kolkata

 

Sample Request

Copiedcurl -X POST "https://voice.zoho.com/rest/json/v2/sms/send" \
  -H "Authorization: Zoho-oauthtoken <access_token>" \
  -H "Content-Type: multipart/form-data" \
  -F 'sms_data={"message":"Hi there!","customerNumber":"1****","senderId":"1****","mms":true}' \
  -F "mms_media=@/path/to/your-file.jpg"

Sample Response - Success

Copied{
  "code": "ZVSMS-2000",
  "send": {
    "multipartCount": 1,
    "country": "us",
    "submittedTime": 1689851513187,
    "customerNumber": "+1 4XXXXXXXXX73",
    "message": "Hello,world!",
    "userName": "Mark",
    "customerName": "+1 4XXXXXXXX3",
    "senderId": "+14XXXXXXXX90",
    "messageType": "OUTGOING",
    "isMMS": true,
    "mmsMeta": [
      {
        "bucketName": "zohovoice-mms-test-6-15327576",
        "fileName": "hd1970_preview.mp4",
        "fileSize": 5125300,
        "objectName": "hd1970_preview.mp4-1689851510892",
        "fileExtn": "mp4",
        "mmsId": "3dff6d5a-ed5d-416d-b24d-f5c3817862e4"
      }
    ],
    "sentTime": "2023-07-20 11:11",
    "logid": "40318972-ffc8-4448-92ec-2f8494eafaa6",
    "email": "mark@zylker.com",
    "status": "IN_QUEUE"
  },
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
 "status": "ERROR",
 "code": "ZVSMS-4027",
 "message": "Bad Request"
}