Introduction

Messages can be created with this API to manually send notifications to a specified set of recipients.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Methods

createMessage

Sends the supplied message to the defined recipients

POST /messages/v1
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Message payload

Response

Status Code

  • Successful request

  • Invalid request

  • Invalid media type

No Sample Response

This method does not specify any sample responses.

getMessageByShortId

Gets a message

GET /messages/v1/{id}
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Path Parameters

  • Short Message ID

Response

Status Code

  • Successful request

  • Unable to locate message

No Sample Response

This method does not specify any sample responses.