Messaging API (v2.1.6)

Download OpenAPI specification:Download

E-mail: support@voicetel.com License: Apache 2.0

Messaging

Customer-facing messaging endpoints.

Campaigns

Query 10DLC CampaignID(s) assigned by TCR.

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/status/ (POST /v2.1/messaging/campaigns/).

apikey required	string
	Array of objects (campaignID)

Responses

Request samples

Payload

Content type

application/json

{"apikey": "Your API Key",
"campaignIDs": [ ]
}

Response samples

200
400
401

Content type

application/json

{"statusCode": "200",
"message": "Campaign results",
"status": "Success",
"campaign_numbers": {"ABC123": ["12012548000"
]
},
"campaign_event_status": {"ABC123": "CAMPAIGN_DCA_COMPLETE"
}
}

Number Disable

Disable SMS and MMS for numbers

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/disable/

required	Array of objects (number)
apikey required	string

Responses

Request samples

Payload

Content type

application/json

{"numbers": [ ],
"apikey": "Your API Key"
}

Response samples

200
400
401
409

Content type

application/json

{"numbers_enabled": {"12012548000": [12012548000
]
},
"message": "Number results",
"status": "Success",
"statusCode": "200"
}

DLR

Get delivery reports

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/dlr/

start	integer
number required	integer
apikey required	string
end	integer

Responses

Request samples

Payload

Content type

application/json

{"start": 0,
"number": 2015551234,
"apikey": "Your API Key",
"end": 0
}

Response samples

200
400
401

Content type

application/json

{"statusCode": "200",
"status": "Success",
"dlr": [ ]
}

Number Enable

Enable SMS and MMS for numbers. An approved 10DLC campaignID will soon be required for enablement.

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/status/ (POST /v2.1/messaging/enable/).

required	Array of objects (enablement)
apikey required	string

Responses

Request samples

Payload

Content type

application/json

{"numbers": [ ],
"apikey": "Your API Key"
}

Response samples

200
400
401
409

Content type

application/json

{"numbers_enabled": {"12012548000": [12012548000
]
},
"message": "Number results",
"status": "Success",
"statusCode": "200"
}

MMS MDR

Get MMS Message Detail Report

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/mdr-mms/

start	integer
number required	integer
apikey required	string
end	integer

Responses

Request samples

Payload

Content type

application/json

{"start": 0,
"number": 2015551234,
"apikey": "Your API Key",
"end": 0
}

Response samples

200
400
401
404

Content type

application/json

{"statusCode": "200",
"status": "Success",
"mdr": [ ]
}

SMS MDR

Get SMS Message Detail Report

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/mdr-sms/

start	integer
number required	integer
apikey required	string
end	integer

Responses

Request samples

Payload

Content type

application/json

{"start": 0,
"number": 2015551234,
"apikey": "Your API Key",
"end": 0
}

Response samples

200
400
401
404

Content type

application/json

{"statusCode": "200",
"status": "Success",
"mdr": [ ]
}

MMS

Send MMS (Multimedia Messaging Service)

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/mms/

mmsURL	string
apikey required	string
messageText required	string
destination required	integer
source required	integer
mmsSubject	string

Responses

Request samples

Payload

Content type

application/json

{"mmsURL": "https://example.com/path",
"apikey": "Your API Key",
"messageText": "Operation completed.",
"destination": 2125551234,
"source": 2015551234,
"mmsSubject": "example"
}

Response samples

Content type

application/json

{"statusCode": "200",
"status": "Success",
"message": {"transaction": {"transactionGUID": "d88231b5-13b3-4fb2-8528-bc7164309389",
"destination": "12015551234"
}
}
}

Route In

Set routing for incoming messages

Authorizations:

apikey

Request Body schema: application/json

Route incoming messages

required	Array of objects (route)
apikey required	string

Responses

Request samples

Payload

Content type

application/json

{"numbers": [ ],
"apikey": "Your API Key"
}

Response samples

200
400
401
409

Content type

application/json

{"statusCode": "200",
"status": "Success",
"message": "Route results",
"numbers": [ ]
}

Route Out

Set routing for outgoing messages

Authorizations:

apikey

Request Body schema: application/json

Route outgoing messages

required	Array of objects (route)
apikey required	string

Responses

Request samples

Payload

Content type

application/json

{"numbers": [ ],
"apikey": "Your API Key"
}

Response samples

200
400
401
409

Content type

application/json

{"statusCode": "200",
"status": "Success",
"message": "Route results",
"numbers": [ ]
}

SMS

Send SMS (Short Message Service)

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/sms/

source required	integer
apikey required	string
messageText required	string
destination required	integer

Responses

Request samples

Payload

Content type

application/json

{"source": 2015551234,
"apikey": "Your API Key",
"messageText": "Operation completed.",
"destination": 2125551234
}

Response samples

Content type

application/json

{"statusCode": "200",
"status": "Success",
"message": {"transaction": {"transactionGUID": "d88231b5-13b3-4fb2-8528-bc7164309389",
"destination": "12015551234"
}
}
}

Number Status

Get SMS and MMS status for numbers

Authorizations:

apikey

Request Body schema: application/json

/v2.1/messaging/enable/

required	Array of objects (number)
apikey required	string

Responses

Request samples

Payload

Content type

application/json

{"numbers": [ ],
"apikey": "Your API Key"
}

Response samples

200
400
401
409

Content type

application/json

{"statusCode": "200",
"status": "Success",
"message": "Number status",
"numbers": [ ]
}