Room's streamId.
The streamId needs to be URLsafe Base64.
To obtain the URLSafe Base64 conversation ID:
Replace forward slashes / with underscores _
Replace pluses + with minuses -
Ignore any trailing equal signs =
For example, the URLSafe Base64 encoding of: lX1hwfmQ+AK/k/a/BB0y2n///q2+0KfbdA== converts to lX1hwfmQ-AK_k_a_BB0y2n___q2-0KfbdA.
Body
attachmentsDisabledboolean
Allows to enable or disable attachments in a room. Only supported for WhatsApp.
List all rooms where an advisor is either a member or an owner for a given network.
Search is performed with the advisor's Symphony user ID.
This end point returns at most 25 records per page.
Room's streamId.
The streamId needs to be URL safe Base64.
To obtain the URLSafe Base64 conversation ID:
Replace forward slashes / with underscores _
Replace pluses + with minuses -
Ignore any trailing equal signs =
For example, the URLSafe Base64 encoding of: lX1hwfmQ+AK/k/a/BB0y2n///q2+0KfbdA== converts to lX1hwfmQ-AK_k_a_BB0y2n___q2-0KfbdA.
Room's streamId.
The streamId needs to be URLsafe Base64.
To obtain the URLSafe Base64 Conversation ID:
replace forward slashes / with underscores
replace pluses + with minuses -
ignore any trailing equal signs =
For example, the URLSafe Base64 encoding of: lX1hwfmQ+AK/k/a/BB0y2n///q2+0KfbdA== converts to lX1hwfmQ-AK_k_a_BB0y2n___q2-0KfbdA.
Room's streamId.
The streamID needs to be URLsafe Base64.
To obtain the URLSafe Base64 conversation ID:
Replace forward slashes / with underscores _
Replace pluses + with minuses -
Ignore any trailing equal signs =
For example, the URLSafe Base64 encoding of: lX1hwfmQ+AK/k/a/BB0y2n///q2+0KfbdA== converts to lX1hwfmQ-AK_k_a_BB0y2n___q2-0KfbdA.
Body
memberSymphonyId*string (number)
advisorSymphonyId*string (number)
externalNetwork*string
External network: WECHAT or WHATSAPP or SMS or SMS-DIRECT or LINE
contact*boolean
Boolean indicating whether added member is an advisor (false) or a federated user (true)
empChannelConnectorstring
ID of the Emp channel Connector to use to reach the federated user. Required for LINE in case automatic LINE channel selection feature is not enabled for your tenant, not applicable for the other external networks.
Response
Member successfully added to the room
Body
streamIdstring
symphonyIdstring
federatedUserIdstring
externalNetworkstring
External network: WECHAT or WHATSAPP or SMS or SMS-DIRECT or LINE
firstNamestring
lastNamestring
companyNamestring
avatarstring
displayNamestring
emailAddressstring
isOwnerboolean
empChannelConnectorall of
Network channel connector used for room member. Only for LINE
Create a room with the advisor whose Symphony user ID is provided.
The advisor is set as a member.
"externalNetworkRoomDisplayName" applies for WeChat only.
POSThttps://CONNECT-DOMAIN/api/v2/customer/rooms
Authorization
Body
roomName*string
federationGroupIdstring
externalNetworkRoomDisplayNamestring
ownerSymphonyId*string (number)
externalNetwork*string
External network: WECHAT or WHATSAPP or SMS or SMS-DIRECT or LINE
Add multiple advisors and/or contacts to a room.
An advisor must be entitled for the relevant external network. A contact must have already been onboarded.