/inbound/sms/{id}/command_actions

Secured By: Authentication Token
Description:

List command actions taken for a particular inbound sms message.

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/{id}/command_actions?page=1>; rel="first",
< /inbound/sms/{id}/command_actions?page=2>; rel="prev",
< /inbound/sms/{id}/command_actions?page=4>; rel="next",
< /inbound/sms/{id}/command_actions?page=5>; rel="last"

Body

Format: application/json

Example
[
  {
    "status": 200,
    "content_type": "text/plain; charset=utf-8",
    "response_body": "Hello Command Action!",
    "created_at": "2013-04-01T01:06:39Z",
    "_links": {
      "self": "/inbound/sms/10121/command_actions/10080",
      "inbound_sms_message": "/inbound/sms/10121",
      "command": "/keywords/10000/commands/10000"
    }
  }
]
Schema
Array of objects that may include:
Name Type Description
status integer

The HTTP status returned from an external HTTP/S request

Example

200
content_type string

The content type returned from an external HTTP/S request

Example

text/plain; charset=utf-8
response_body string

The response body returned from an external HTTP/S request

Example

Hello Command Action!
created_at string

The date and time when the command action was created.

Example

2013-01-30T17:45:27Z
_links object

An object that defines links to related objects.

Properties

{
  "self": {
    "description": "Relative URI of the object",
    "type": "string",
    "example": "/inbound/sms/2/command_actions/10080"
  },
  "inbound_sms_message": {
    "description": "URI of associated parent SMS.",
    "type": "string",
    "example": "/inbound/sms/10121"
  },
  "command": {
    "description": "URI of associated keyword command.",
    "type": "string",
    "example": "/keywords/10000/commands/10000"
  }
}
 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Inbound SMS Command Actions",
  "description": "A list command actions that have been taken for a particular inbound SMS.",
  "type": "array",
  "items": {
    "title": "Command Action",
    "type": "object",
    "properties": {
      "status": {
        "description": "The HTTP status returned from an external HTTP/S request",
        "type": "integer",
        "example": 200
      },
      "content_type": {
        "description": "The content type returned from an external HTTP/S request",
        "type": "string",
        "example": "text/plain; charset=utf-8"
      },
      "response_body": {
        "description": "The response body returned from an external HTTP/S request",
        "type": "string",
        "example": "Hello Command Action!"
      },
      "created_at": {
        "description": "The date and time when the command action was created.",
        "type": "string",
        "example": "2013-01-30T17:45:27Z"
      },
      "_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/command_actions/10080"
          },
          "inbound_sms_message": {
            "description": "URI of associated parent SMS.",
            "type": "string",
            "example": "/inbound/sms/10121"
          },
          "command": {
            "description": "URI of associated keyword command.",
            "type": "string",
            "example": "/keywords/10000/commands/10000"
          }
        }
      }
    }
  }
}

Body

Format: application/json

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