Create member

POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members
Account sid auth token

Users joined to specific channels

Headers

  • X-Twilio-Webhook-Enabled string

    The X-Twilio-Webhook-Enabled HTTP request header

    Values are true or false.

Path parameters

  • ServiceSid string Required

    The SID of the Service to create the Member resource under.

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

  • ChannelSid string Required

    The SID of the Channel the new Member resource belongs to. This value can be the Channel resource's sid or unique_name.

application/x-www-form-urlencoded

Body

  • Identity string Required

    The identity value that uniquely identifies the new resource's User within the Service. See access tokens for more info.

  • RoleSid string

    The SID of the Role to assign to the member. The default roles are those specified on the Service.

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

  • LastConsumedMessageIndex integer | null

    The index of the last Message in the Channel that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source.

  • LastConsumptionTimestamp string(date-time)

    The ISO 8601 timestamp of the last Message read event for the Member within the Channel.

  • DateCreated string(date-time)

    The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source.

  • DateUpdated string(date-time)

    The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. The default value is null. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated.

  • Attributes string

    A valid JSON string that contains application-specific data.

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

      The unique string that we created to identify the Member resource.

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

    • account_sid string | null

      The SID of the Account that created the Member resource.

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

    • channel_sid string | null

      The SID of the Channel the Member resource belongs to.

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

    • service_sid string | null

      The SID of the Service the Member resource is associated with.

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

    • identity string | null

      The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • role_sid string | null

      The SID of the Role assigned to the member.

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

    • last_consumed_message_index integer | null

      The index of the last Message in the Channel that the Member has read.

    • last_consumption_timestamp string(date-time) | null

      The ISO 8601 timestamp of the last Message read event for the Member within the Channel.

    • url string(uri) | null

      The absolute URL of the Member resource.

    • attributes string | null

      The JSON string that stores application-specific data. If attributes have not been set, {} is returned.
POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members 
curl \
 --request POST 'https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --header "X-Twilio-Webhook-Enabled: true" \
 --data 'Identity=Twilio&Attributes=%7B%7D'
Request example 
{"Identity"=>"Twilio", "Attributes"=>"{}"}
Response examples (201) 
{
  "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "identity": "jing",
  "role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "attributes": "{}",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2016-03-24T21:05:50Z",
  "date_updated": "2016-03-24T21:05:50Z",
  "last_consumption_timestamp": null,
  "last_consumed_message_index": null
}