Create channel

POST /v1/Services/{ServiceSid}/Channels
Account sid auth token

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.

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 /v1/Services/{ServiceSid}/Channels 
curl \
 --request POST 'https://ip-messaging.twilio.com/v1/Services/{ServiceSid}/Channels' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Type=public&Attributes=%7B+%22foo%22%3A+%22bar%22+%7D&UniqueName=unique_name&FriendlyName=friendly_name'
Request example 
{"Type"=>"public", "Attributes"=>"{ \"foo\": \"bar\" }", "UniqueName"=>"unique_name", "FriendlyName"=>"friendly_name"}
Response examples (201) 
{
  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "public",
  "links": {
    "invites": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites",
    "members": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members",
    "messages": "https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages",
    "last_message": null
  },
  "attributes": "{ \"foo\": \"bar\" }",
  "created_by": "system",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "date_created": "2015-12-16T22:18:37Z",
  "date_updated": "2015-12-16T22:18:37Z",
  "friendly_name": "friendly_name",
  "members_count": 0,
  "messages_count": 0
}