POST api/customersms

Create and send an text message.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, POSTapi/customersms. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

SMS data.

SmsDto
NameDescriptionTypeAdditional information
TelephoneNumber

Telephone Number.

 string
Message

Text Message.

 string
CustomerID

Customer Id.

 integer
PersonID

Customer's Person Id.

 integer

Request Formats

application/json, text/json

Sample: 
{
  "telephoneNumber": "sample string 1",
  "message": "sample string 2",
  "customerID": 1,
  "personID": 1
}

application/xml, text/xml

Sample: 
<SmsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <CustomerID>1</CustomerID>
  <Message>sample string 2</Message>
  <PersonID>1</PersonID>
  <TelephoneNumber>sample string 1</TelephoneNumber>
</SmsDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Success Status:

  • Created (201), the HTTP response location header field contains the Uri of the newely created resource. Please see resource description below.

Failed Status(es):

Resource Description

Returns the created text message.

SmsDto
NameDescriptionTypeAdditional information
TelephoneNumber

Telephone Number.

 string
Message

Text Message.

 string
CustomerID

Customer Id.

 integer
PersonID

Customer's Person Id.

 integer

Response Formats

application/json, text/json

Sample: 
{
  "telephoneNumber": "sample string 1",
  "message": "sample string 2",
  "customerID": 1,
  "personID": 1
}

application/xml, text/xml

Sample: 
<SmsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <CustomerID>1</CustomerID>
  <Message>sample string 2</Message>
  <PersonID>1</PersonID>
  <TelephoneNumber>sample string 1</TelephoneNumber>
</SmsDto>