/inbound/sms/{id}

Secured By: Authentication Token
Description:

Get details for a particular inbound sms message.

Headers

Name Required Type Description
X-AUTH-TOKEN * string

An authentication token provided to you by GovDelivery.

Status

Body

Format: application/json

Example
{
  "from": "5551112222",
  "to": "SHORTCODE",
  "body": "hi there 805",
  "created_at": "2012-10-31T20:04:46Z",
  "command_status": "success",
  "_links": {
    "self": "/inbound/sms/1",
    "command_actions": "/inbound/sms/1/command_actions"
  }
}
Schema
Object 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 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"
}