POST api/clickatell/send

Request Information

URI Parameters

None.

Body Parameters

SendRequest
NameDescriptionTypeAdditional information
AccountID

integer

None.

Content

string

None.

ToList

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountID": 1,
  "Content": "sample string 2",
  "ToList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<SendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Clickatell">
  <AccountID>1</AccountID>
  <Content>sample string 2</Content>
  <ToList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ToList>
</SendRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SendResponse
NameDescriptionTypeAdditional information
messages

Collection of MessageResult

None.

errorDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "messages": [
    {
      "apiMessageId": "sample string 1",
      "accepted": true,
      "to": "sample string 3",
      "errorDescription": "sample string 4"
    },
    {
      "apiMessageId": "sample string 1",
      "accepted": true,
      "to": "sample string 3",
      "errorDescription": "sample string 4"
    }
  ],
  "errorDescription": "sample string 1"
}

application/xml, text/xml

Sample:
<SendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Clickatell">
  <errorDescription>sample string 1</errorDescription>
  <messages>
    <MessageResult>
      <accepted>true</accepted>
      <apiMessageId>sample string 1</apiMessageId>
      <errorDescription>sample string 4</errorDescription>
      <to>sample string 3</to>
    </MessageResult>
    <MessageResult>
      <accepted>true</accepted>
      <apiMessageId>sample string 1</apiMessageId>
      <errorDescription>sample string 4</errorDescription>
      <to>sample string 3</to>
    </MessageResult>
  </messages>
</SendResponse>