Send SMS with Africa's Talking through Courier - Courier

Prerequisites

An Africa’s Talking account
Your Africa’s Talking API Key and Application Username

Setup

Open the in Courier, enter your API Key and Application Username, 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. A provider override changes what Courier sends to the Africa’s Talking SMS API. For example, add a registered short code or alphanumeric sender ID from your Africa’s Talking application:

const { requestId } = await courier.send.message({
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      phone_number: "+27765559758",
    },
    providers: {
      "africastalking-sms": {
        override: {
          body: {
            from: "12345",
          },
        },
      },
    },
  },
});

response = client.send.message(
    message={
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "to": {
            "phone_number": "+27765559758",
        },
        "providers": {
            "africastalking-sms": {
                "override": {
                    "body": {
                        "from": "12345",
                    },
                },
            },
        },
    },
)

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": "+27765559758"
      },
      "providers": {
        "africastalking-sms": {
          "override": {
            "body": {
              "from": "12345"
            }
          }
        }
      }
    }
  }'

response = courier.send_.message(
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      phone_number: "+27765559758"
    },
    providers: {
      "africastalking-sms": {
        override: {
          body: {
            from: "12345"
          }
        }
      }
    }
  }
)

response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
	Message: courier.SendMessageParamsMessage{
		To: courier.SendMessageParamsMessageToUnion{
			OfUserRecipient: &shared.UserRecipientParam{
				PhoneNumber: courier.String("+27765559758"),
			},
		},
		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
		Providers: shared.MessageProvidersParam{
			"africastalking-sms": shared.MessageProvidersTypeParam{
				Override: map[string]any{
					"body": map[string]any{
						"from": "12345",
					},
				},
			},
		},
	},
})

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().phoneNumber("+27765559758").build())
        .template("nt_01kx4h2jdafq8bk9aftxak4b40")
        .providers(MessageProviders.builder()
            .putAdditionalProperty("africastalking-sms", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                    "body", java.util.Map.of(
                        "from", "12345"
                    )
                ))))
            .build())
        .build())
    .build();
SendMessageResponse response = client.send().message(params);

$response = $client->send->message(
  message: [
    'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
    'to' => [
      'phone_number' => '+27765559758',
    ],
    'providers' => [
      'africastalking-sms' => [
        'override' => [
          'body' => [
            'from' => '12345',
          ],
        ],
      ],
    ],
  ],
);

SendMessageParams parameters = new()
{
    Message = new()
    {
        To = new UserRecipient { PhoneNumber = "+27765559758" },
        Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
        Providers = new Dictionary<string, MessageProvidersType>()
        {
            {
                "africastalking-sms",
                new()
                {
                    Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                        """
                        {
                          "body": {
                            "from": "12345"
                          }
                        }
                        """
                    ),
                }
            },
        },
    },
};

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

courier send message \
  --api-key "$COURIER_API_KEY" \
  --message.to '{"phone_number": "+27765559758"}' \
  --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
  --message.providers '{"africastalking-sms": {"override": {"body": {"from": "12345"}}}}'

With Courier MCP, send my template to +27765559758 with my Africa's Talking sender id.

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 Africa’s Talking SMS API docs.

Provider details

africastalking-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.

⌘I