Get MessageBird (Bird) SMS Status

Checks the delivery status of one Bird SMS by its message id.

Unverified

What the model is told

Look up the status of an SMS you sent earlier, using the message id returned when it was sent. Returns a status such as accepted, sent, delivered, undelivered, failed, expired or rejected.

Request

GEThttps://YOUR_BIRD_REGION.platform.bird.com/v1/sms/messages/{{messageId}}

Headers

AuthorizationBearer YOUR_BIRD_API_KEY

Parameters

messageId stringThe message id returned when the SMS was sent.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "b891603b-5777-44cb-bbac-d2ed791582b4",
    "type": "HTTP_REQUEST",
    "label": "Get MessageBird (Bird) SMS Status",
    "name": "get_messagebird_bird_sms_status",
    "customName": false,
    "description": "Look up the status of an SMS you sent earlier, using the message id returned when it was sent. Returns a status such as accepted, sent, delivered, undelivered, failed, expired or rejected.",
    "parameters": [
      {
        "name": "messageId",
        "type": "string",
        "description": "The message id returned when the SMS was sent."
      }
    ],
    "config": {
      "endpoint": {
        "method": "GET",
        "url": "https://YOUR_BIRD_REGION.platform.bird.com/v1/sms/messages/{{messageId}}"
      },
      "headers": [
        {
          "name": "Authorization",
          "value": "Bearer YOUR_BIRD_API_KEY"
        }
      ],
      "body": null,
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.