post https://api.amio.io/v1/channels
Response Body Params
Parameter | Type | Description |
---|---|---|
id | string | Id of the channel. |
type | string | Channel type specifying the underlying platform: mobile . |
name | string | Name of the channel. |
mode | string | Mode 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. |
webhook | object | Webhook 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.id | string | Id of the webhook. |
webhook.url | string | Webhook url. |
webhook.secret | string | Secret token for securing received webhook calls, see Webhook Security for more details. |
webhook.ssl_verification | string | Specifies whether to verify SSL certificates or not. Setting this option to false is not recommended. |
provider | object | Represents a provider used to receive and deliver messages. |
provider.type | string | Name of the service provider: messagebird . |
provider.sender_id | string | Phone number registered at the provider or custom sender ID to be used as a message originator. |
provider.access_token | string | Access token used for authorising requests to provider. |
provider.signing_key | string | Signature key used for verifying that incoming webhook came from MessageBird. |
provider.status_webhook_url | string | Amio webhook url to be used by provider to deliver notifications like message delivered, message failed, etc. |
provider.receive_webhook_url | string | Amio webhook url to be used by provider to deliver incoming SMS messages. |