Send SMS with Sinch Engage through Courier

Sinch Engage is MessageMedia rebranded after the Sinch acquisition. It is a different product from Sinch, which is its own integration with its own credentials.The catalog also lists Sinch Engage / MessageMedia under the provider key messagemedia. It takes the same API key and secret and sends the same way, so an integration already on messagemedia keeps working and needs no migration. Use sinch-engage for a new integration.

Keep Sinch Engage as your SMS provider. Courier sends through your Sinch Engage account and adds templates, user preferences, failover to a backup provider, message logs, and more channels like email, push, and in-app Inbox. Sinch Engage bills you for SMS delivery, and Courier bills per send.

Prerequisites

A Sinch Engage account
Access to API settings in the console

Setup

In the console:

Create a new API key

Create a new API key.

Copy the API key and secret

Save the api_secret now. The console won’t show it again.

In Courier, open the Sinch Engage integration page, paste your credentials, and click “Save.”

Sinch Engage console dialog titled New API Credentials Created, showing an API key and API secret (masked) with Copy to clipboard and Ok buttons — API key in the console

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

Overrides

How overrides work covers the two levels and which one wins. Overrides change the request body, config, and headers Courier sends to Sinch Engage. Override apiKey, apiSecret, isHmacEnabled, and url via config, and any SendMessages body field via body.

const { requestId } = await courier.send.message({
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      phone_number: "+12345678901",
    },
    providers: {
      "sinch-engage": {
        override: {
          body: {
            source_number: "+15555555555",
          },
          config: {
            apiKey: "<override API key>",
            apiSecret: "<override API secret>",
          },
        },
      },
    },
  },
});

response = client.send.message(
    message={
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "to": {
            "phone_number": "+12345678901",
        },
        "providers": {
            "sinch-engage": {
                "override": {
                    "body": {
                        "source_number": "+15555555555",
                    },
                    "config": {
                        "apiKey": "<override API key>",
                        "apiSecret": "<override API secret>",
                    },
                },
            },
        },
    },
)

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": {
        "sinch-engage": {
          "override": {
            "body": {
              "source_number": "+15555555555"
            },
            "config": {
              "apiKey": "<override API key>",
              "apiSecret": "<override API secret>"
            }
          }
        }
      }
    }
  }'

response = courier.send_.message(
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      phone_number: "+12345678901"
    },
    providers: {
      "sinch-engage": {
        override: {
          body: {
            source_number: "+15555555555"
          },
          config: {
            apiKey: "<override API key>",
            apiSecret: "<override API secret>"
          }
        }
      }
    }
  }
)

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{
			"sinch-engage": shared.MessageProvidersTypeParam{
				Override: map[string]any{
					"body": map[string]any{
						"source_number": "+15555555555",
					},
					"config": map[string]any{
						"apiKey": "<override API key>",
						"apiSecret": "<override API secret>",
					},
				},
			},
		},
	},
})

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().phoneNumber("+12345678901").build())
        .template("nt_01kx4h2jdafq8bk9aftxak4b40")
        .providers(MessageProviders.builder()
            .putAdditionalProperty("sinch-engage", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                    "body", java.util.Map.of(
                        "source_number", "+15555555555"
                    ),
                    "config", java.util.Map.of(
                        "apiKey", "<override API key>",
                        "apiSecret", "<override API secret>"
                    )
                ))))
            .build())
        .build())
    .build();
SendMessageResponse response = client.send().message(params);

$response = $client->send->message(
  message: [
    'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
    'to' => [
      'phone_number' => '+12345678901',
    ],
    'providers' => [
      'sinch-engage' => [
        'override' => [
          'body' => [
            'source_number' => '+15555555555',
          ],
          'config' => [
            'apiKey' => '<override API key>',
            'apiSecret' => '<override API secret>',
          ],
        ],
      ],
    ],
  ],
);

SendMessageParams parameters = new()
{
    Message = new()
    {
        To = new UserRecipient { PhoneNumber = "+12345678901" },
        Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
        Providers = new Dictionary<string, MessageProvidersType>()
        {
            {
                "sinch-engage",
                new()
                {
                    Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                        """
                        {
                          "body": {
                            "source_number": "+15555555555"
                          },
                          "config": {
                            "apiKey": "<override API key>",
                            "apiSecret": "<override API secret>"
                          }
                        }
                        """
                    ),
                }
            },
        },
    },
};

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 '{"sinch-engage": {"override": {"body": {"source_number": "+15555555555"}, "config": {"apiKey": "<override API key>", "apiSecret": "<override API secret>"}}}}'

With Courier MCP, send my template to +12345678901 through Sinch Engage with a different API key.

Delivery tracking

Courier gives the integration a unique webhook URL. Point the provider’s webhooks at it to sync delivery updates into Courier’s message logs. Copy the URL from the Sinch Engage integration in Courier, then follow these steps in the console:

Create a new webhook

Select “New Webhook”.

Paste Courier's webhook URL

Paste the URL you copied.

Select the delivery report events

Under “Event”, select “Message is rejected”, “Message has failed”, and “Message is delivered” in Delivery reports.

Sinch Engage webhook configuration with POST selected and the Message is rejected, failed, and delivered delivery reports checked — Webhook configuration

Map the webhook content

Under “Content”, map the fields passed to Courier’s webhook endpoint.

Only messageId, receivedTimestamp, status, and statusCode are supported.

Sinch Engage webhook Content mapping messageId, receivedTimestamp, status, and statusCode to their matching $ variables — Webhook Content Mapping

Delivery updates now appear in the message logs.

A Courier message log for a Sinch Engage send, ending in Delivery Confirmed, with the delivered status payload — Delivery Confirmation

Provider details

sinch-engage

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 Sinch Engage through Courier

Prerequisites

Setup

Overrides

Delivery tracking

Provider details

Send to a specific provider

​Prerequisites

​Setup

​Overrides

​Delivery tracking

​Provider details

Send to a specific provider

Prerequisites

Setup

Overrides

Delivery tracking

Provider details