Create channel

POST /v2/Services/{ServiceSid}/Channels

Account sid auth token

Headers

X-Twilio-Webhook-Enabled string

The X-Twilio-Webhook-Enabled HTTP request header

Values are true or false.

Path parameters

ServiceSid string Required

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

FriendlyName string
UniqueName string
Attributes string
Type string

Values are public or private.
DateCreated string(date-time)
DateUpdated string(date-time)
CreatedBy string

Responses

201 application/json

Created
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.
- account_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- service_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- friendly_name string | null
- unique_name string | null
- attributes string | null
- type string
  
  Values are public or private.
- date_created string(date-time) | null
- date_updated string(date-time) | null
- created_by string | null
- members_count integer
  
  Default value is 0.
- messages_count integer
  
  Default value is 0.
- url string(uri) | null
- links object(uri-map) | null

POST /v2/Services/{ServiceSid}/Channels

curl \
 --request POST 'https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/Channels' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --header "X-Twilio-Webhook-Enabled: true" \
 --data 'Type=public&CreatedBy=username&Attributes=%7B+%22foo%22%3A+%22bar%22+%7D&UniqueName=unique_name&DateCreated=2015-12-16T22%3A18%3A37Z&DateUpdated=2015-12-16T22%3A18%3A38Z&FriendlyName=friendly_name'

Request example

{"Type"=>"public", "CreatedBy"=>"username", "Attributes"=>"{ \"foo\": \"bar\" }", "UniqueName"=>"unique_name", "DateCreated"=>"2015-12-16T22:18:37Z", "DateUpdated"=>"2015-12-16T22:18:38Z", "FriendlyName"=>"friendly_name"}

Response examples (201)

{
  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "public",
  "links": {
    "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites",
    "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members",
    "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages",
    "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks",
    "last_message": null
  },
  "attributes": "{ \"foo\": \"bar\" }",
  "created_by": "username",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "date_created": "2015-12-16T22:18:37Z",
  "date_updated": "2015-12-16T22:18:38Z",
  "friendly_name": "friendly_name",
  "members_count": 0,
  "messages_count": 0
}