POST api/v1/sms/send

Endpoint to send sms.

Request Information

URI Parameters

None.

Body Parameters

SmsRequest
NameDescriptionTypeAdditional information
Body

Message Body.

 string

Required
Number

Number to send the message.

 string

Required

Matching regular expression pattern: \+[0-9]+

Min length: 10
DeviceKey

Code to identify the device sending the message

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Body": "sample string 1",
  "Number": "sample string 2",
  "DeviceKey": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SendSmsResponse
NameDescriptionTypeAdditional information
Success

True if the message is sent, false if something is wrong.

 boolean

None.
Message

Result Message.

 string

None.
Number

Destination number.

 string

None.
Body

Message Body.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Message": "sample string 2",
  "Number": "sample string 3",
  "Body": "sample string 4"
}