/inbound/sms

Secured By: Authentication Token
Description:

List inbound sms messages.

Responses with more than 50 records will be paginated to 50 records per response, unless otherwise specified.

Headers

Name Required Type Description
X-AUTH-TOKEN * string

An authentication token provided to you by GovDelivery.

Status

Headers

Name Type Description
Link string

Appropriate pagination link relations. Can include “first”, “last”, “prev”, and “next” relations.

Example

< /inbound/sms?page=1>; rel="first",
< /inbound/sms?page=2>; rel="prev",
< /inbound/sms?page=4>; rel="next",
< /inbound/sms?page=5>; rel="last"

Body

Format: application/json

Example
[
  {
    "body": "hi there 805",
    "created_at": "2012-10-31T20:04:46Z",
    "from": "5551112222",
    "to": "SHORTCODE",
    "_links": {
      "self": "/inbound/sms/1"
    },
  },
  {
    "body": "hi there 806",
    "created_at": "2012-10-31T20:04:46Z",
    "from": "5551112222",
    "to": "SHORTCODE",
    "_links": {
      "self": "/inbound/sms/2"
    },
  }
]
Schema
Array of objects that may include:
Name Type Description
body string

Content of the SMS

Example

Hello TMS!
created_at string

The date and time when the message was created.

Example

2013-01-30T17:45:27Z
from string

The phone number that sent the message.

Example

+15551112222
to string

The phone number or shortcode that received the message.

Example

GOVD311
_links object

An object that defines links to related objects.

Properties

{
  "self": {
    "description": "Relative URI of the object",
    "type": "string",
    "example": "/inbound/sms/2"
  }
}
 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Inbound SMS Messages",
  "description": "A list of messages that have been received by TMS.",
  "type": "array",
  "items": {
    "title": "Inbound SMS Message",
    "type": "object",
    "properties": {
      "body": {
        "description": "Content of the SMS",
        "type": "string",
        "example": "Hello TMS!"
      },
      "created_at": {
        "description": "The date and time when the message was created.",
        "type": "string",
        "example": "2013-01-30T17:45:27Z"
      },
      "from": {
        "description": "The phone number that sent the message.",
        "type": "string",
        "example": "+15551112222"
      },
      "to": {
        "description": "The phone number or shortcode that received the message.",
        "type": "string",
        "example": "GOVD311"
      },
      "_links": {
        "title": "Relational Links",
        "description": "An object that defines links to related objects.",
        "type": "object",
        "properties": {
          "self": {
            "description": "Relative URI of the object",
            "type": "string",
            "example": "/inbound/sms/2"
          }
        }
      }
    }
  }
}

Body

Format: application/json

Example
{
  "error": "Invalid authentication token"
}