AIairship
SMS

SMS channel lookup

Changed on

Lookup an SMS channel by msisdn and sender.

get/api/channels/sms/{msisdn}/{sender}

Request

Path parameters

msisdninteger required

The mobile phone number you want to look up a channel for. 15 digits maximum; may not contain leading zeroes.

senderinteger required

A long or short code the app is configured to send from.

Response

Returns an SMS channel object. An SMS channel object includes tag groups for ua_channel_type, ua_sender_id, and ua_opt_in.

okboolean

Success.

Example response

{
  "channel": {
    "address": "email@example.com",
    "channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5",
    "email_address": "name@example.com",
    "ios": {
      "quiettime": {
        "end": "07:30",
        "start": "21:30"
      },
      "tz": "America/Los_Angeles"
    },
    "msisdn": "15035556789",
    "named_user_id": "john_doe",
    "open": {
      "identifiers": {
        "slack-handle": "slackinator"
      },
      "open_platform_name": "Slack"
    },
    "opt_in_date": "2022-07-07T03:23:13",
    "opt_out_date": "2022-07-08T03:23:13",
    "push_address": "FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660",
    "subscription_lists": [
      {
        "action": {
          "list_id": "90s_rap_videos"
        },
        "list_id": "90s_rap_videos"
      }
    ],
    "tags": [
      "Federer fan",
      "Messi fan"
    ]
  }
}

Changes

  • bd6ab947117aRevision changes
    • breaking

      added subschema #1: Channel subscription list action to the /// response property oneOf list for the response status

    This list may be incomplete.

  • 38241778b0c1Revision changes
    • warning

      removed the optional property / from the response with the status

    This list may be incomplete.