/AWS1/CL_CHE=>CREATECHANNEL()
¶
About CreateChannel¶
Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer
request header is mandatory. Use the
AppInstanceUserArn
of the user that makes the API call as the value in
the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_APPINSTANCEARN
TYPE /AWS1/CHECHIMEARN
/AWS1/CHECHIMEARN
¶
The ARN of the channel request.
IV_NAME
TYPE /AWS1/CHENONEMPTYRESOURCENAME
/AWS1/CHENONEMPTYRESOURCENAME
¶
The name of the channel.
IV_CLIENTREQUESTTOKEN
TYPE /AWS1/CHECLIENTREQUESTTOKEN
/AWS1/CHECLIENTREQUESTTOKEN
¶
The client token for the request. An
Idempotency
token.
Optional arguments:¶
IV_MODE
TYPE /AWS1/CHECHANNELMODE
/AWS1/CHECHANNELMODE
¶
The channel mode:
UNRESTRICTED
orRESTRICTED
. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
IV_PRIVACY
TYPE /AWS1/CHECHANNELPRIVACY
/AWS1/CHECHANNELPRIVACY
¶
The channel's privacy level:
PUBLIC
orPRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in theAppInstance
.
IV_METADATA
TYPE /AWS1/CHEMETADATA
/AWS1/CHEMETADATA
¶
The metadata of the creation request. Limited to 1KB and UTF-8.
IT_TAGS
TYPE /AWS1/CL_CHETAG=>TT_TAGLIST
TT_TAGLIST
¶
The tags for the creation request.
IV_CHIMEBEARER
TYPE /AWS1/CHECHIMEARN
/AWS1/CHECHIMEARN
¶
The
AppInstanceUserArn
of the user that makes the API call.