Send SMS with Bird through Courier

Prerequisites

A Bird account
Your Bird access key
An originating phone number in Bird

Setup

Get your Bird access key

In Bird, open your workspace and copy an access key. The originator is the number or sender ID you send from.

Configure in Courier

Open the in Courier, enter your access key and originator number, then click “Save.”

Addressing a recipient and sending are the same on every SMS provider, so they are documented once: and .

Overrides

covers the two levels and which one wins. Overrides change the request body and config Courier uses to send through Bird. config overrides the accessKey. body overrides any message body field. Bird was called MessageBird when this integration shipped, so its provider key is still messagebird-sms.

const { requestId } = await courier.send.message({
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      phone_number: "+12345678901",
    },
    providers: {
      "messagebird-sms": {
        override: {
          body: {
            originator: "MyCompany",
          },
          config: {
            accessKey: "<override access key>",
          },
        },
      },
    },
  },
});

response = client.send.message(
    message={
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "to": {
            "phone_number": "+12345678901",
        },
        "providers": {
            "messagebird-sms": {
                "override": {
                    "body": {
                        "originator": "MyCompany",
                    },
                    "config": {
                        "accessKey": "<override access key>",
                    },
                },
            },
        },
    },
)

curl -X POST https://api.courier.com/send \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": {
      "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
      "to": {
        "phone_number": "+12345678901"
      },
      "providers": {
        "messagebird-sms": {
          "override": {
            "body": {
              "originator": "MyCompany"
            },
            "config": {
              "accessKey": "<override access key>"
            }
          }
        }
      }
    }
  }'

response = courier.send_.message(
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      phone_number: "+12345678901"
    },
    providers: {
      "messagebird-sms": {
        override: {
          body: {
            originator: "MyCompany"
          },
          config: {
            accessKey: "<override access key>"
          }
        }
      }
    }
  }
)

response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
	Message: courier.SendMessageParamsMessage{
		To: courier.SendMessageParamsMessageToUnion{
			OfUserRecipient: &shared.UserRecipientParam{
				PhoneNumber: courier.String("+12345678901"),
			},
		},
		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
		Providers: shared.MessageProvidersParam{
			"messagebird-sms": shared.MessageProvidersTypeParam{
				Override: map[string]any{
					"body": map[string]any{
						"originator": "MyCompany",
					},
					"config": map[string]any{
						"accessKey": "<override access key>",
					},
				},
			},
		},
	},
})

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().phoneNumber("+12345678901").build())
        .template("nt_01kx4h2jdafq8bk9aftxak4b40")
        .providers(MessageProviders.builder()
            .putAdditionalProperty("messagebird-sms", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                    "body", java.util.Map.of(
                        "originator", "MyCompany"
                    ),
                    "config", java.util.Map.of(
                        "accessKey", "<override access key>"
                    )
                ))))
            .build())
        .build())
    .build();
SendMessageResponse response = client.send().message(params);

$response = $client->send->message(
  message: [
    'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
    'to' => [
      'phone_number' => '+12345678901',
    ],
    'providers' => [
      'messagebird-sms' => [
        'override' => [
          'body' => [
            'originator' => 'MyCompany',
          ],
          'config' => [
            'accessKey' => '<override access key>',
          ],
        ],
      ],
    ],
  ],
);

SendMessageParams parameters = new()
{
    Message = new()
    {
        To = new UserRecipient { PhoneNumber = "+12345678901" },
        Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
        Providers = new Dictionary<string, MessageProvidersType>()
        {
            {
                "messagebird-sms",
                new()
                {
                    Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                        """
                        {
                          "body": {
                            "originator": "MyCompany"
                          },
                          "config": {
                            "accessKey": "<override access key>"
                          }
                        }
                        """
                    ),
                }
            },
        },
    },
};

var response = await client.Send.Message(parameters);

courier send message \
  --api-key "$COURIER_API_KEY" \
  --message.to '{"phone_number": "+12345678901"}' \
  --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
  --message.providers '{"messagebird-sms": {"override": {"body": {"originator": "MyCompany"}, "config": {"accessKey": "<override access key>"}}}}'

With Courier MCP, send my template to +12345678901 through Bird with a different access key.

Overrides are deep-merged into the request. Fields you set replace their counterparts, and everything you leave out is still sent. The full field list is in the Bird SMS API docs.

Provider details

messagebird-sms

Courier recommends routing to the channel. Naming this key in routing.channels instead is supported, and sends through just this provider.

Send to a specific provider

When that is worth doing, and what you give up: failover, channel priority, and providers you add later.

Get started

Available integrations

Send SMS with Bird through Courier

Prerequisites

Setup

Overrides

Provider details

Send to a specific provider

​Prerequisites

​Setup

​Overrides

​Provider details

Send to a specific provider

Prerequisites

Setup

Overrides

Provider details