Create channel

POST /v2/Services/{ServiceSid}/Channels

TODO: Resource-level docs

Headers

X-Twilio-Webhook-Enabled string

The X-Twilio-Webhook-Enabled HTTP request header

Values are true or false.

Path parameters

ServiceSid string Required

Body

Attributes string
CreatedBy string
DateCreated string(date-time)
DateUpdated string(date-time)
FriendlyName string
Type string

Values are public or private.
UniqueName string

Responses

201

Created
Hide response attributes Show response attributes object
- account_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- attributes string | null
- created_by string | null
- date_created string(date-time) | null
- date_updated string(date-time) | null
- friendly_name string | null
- links object(uri-map) | null
- members_count integer | null
- messages_count integer | null
- service_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.
- type string | null
  
  Values are public or private.
- unique_name string | null
- url string(uri) | null

POST /v2/Services/{ServiceSid}/Channels

curl \
 -X POST https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/Channels \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "X-Twilio-Webhook-Enabled: true" \
 -d 'Attributes=string&CreatedBy=string&DateCreated=2023-05-04T09%3A42%3A00%2B00%3A00&DateUpdated=2023-05-04T09%3A42%3A00%2B00%3A00&FriendlyName=string&Type=public&UniqueName=string'

Request example

# Headers
X-Twilio-Webhook-Enabled: true

# Payload
{
  "Attributes": "string",
  "CreatedBy": "string",
  "DateCreated": "2023-05-04T09:42:00+00:00",
  "DateUpdated": "2023-05-04T09:42:00+00:00",
  "FriendlyName": "string",
  "Type": "public",
  "UniqueName": "string"
}

Request examples

# Headers
X-Twilio-Webhook-Enabled: true

# Payload
{
  "Attributes": "string",
  "CreatedBy": "string",
  "DateCreated": "2024-05-04T09:42:00+00:00",
  "DateUpdated": "2024-05-04T09:42:00+00:00",
  "FriendlyName": "string",
  "Type": "public",
  "UniqueName": "string"
}

Response examples (201)

{
  "account_sid": "string",
  "attributes": "string",
  "created_by": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "members_count": 42,
  "messages_count": 42,
  "service_sid": "string",
  "sid": "string",
  "type": "public",
  "unique_name": "string",
  "url": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "attributes": "string",
  "created_by": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "members_count": 42,
  "messages_count": 42,
  "service_sid": "string",
  "sid": "string",
  "type": "public",
  "unique_name": "string",
  "url": "https://example.com"
}