List Channels

Response Body Params

ParameterTypeDescription
idstringId of the channel.
typestringChannel type specifying the underlying platform: mobile.
namestringName of the channel.
modestringMode of the channel.
production - Send Message requests will be accepted and sent as SMS.
test - Send Message requests will be accepted but won't be processed any further. This avoids the cost of sending the message as SMS.
webhookobjectWebhook object specifies the entry point to which all events are delivered. It is null if there is no webhook set. See Webhooks for more details.
webhook.idstringId of the webhook.
webhook.urlstringWebhook url.
webhook.secretstringSecret token for securing received webhook calls, see Webhook Security for more details.
webhook.ssl_verificationstringSpecifies whether to verify SSL certificates or not. Setting this option to false is not recommended.
providerobjectRepresents a provider used to receive and deliver messages.
provider.typestringName of the service provider: messagebird.
provider.sender_idstringPhone number registered at the provider to be used as a sender number. Any string in case of using shared number.
provider.access_tokenstringAccess token used for authorising requests to provider.
provider.signing_keystringSignature key used for verifying that incoming webhook came from MessageBird.
provider.status_webhook_urlstringAmio webhook url to be used by provider to deliver notifications like message delivered, message failed, etc.
provider.receive_webhook_urlstringAmio webhook url to be used by provider to deliver incoming SMS messages.
Language
Credentials