提供: Bright Pattern Documentation
• English
startChat
新規SMSのやり取りを作成します。
リクエスト
構文
| startSMSChat(channel: ChatChannelType, アドレス: string, initialObject?: InteractionAssociatedObject): Promise<OPERATIONRESULT<null>> |
:
| type ChatChannelType = |
"sms" | type InteractionAssociatedObject = { id: string type: string displayName: string displayType: string customFields: Record<STRING, string> } |
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション/必須 | 説明 |
| channel | 文字列 | 必須 | サポートされているチャットチャンネルのいずれかを指定できます。 | |
| アドレス | 文字列 | 必須 | チャットを開始したい電話番号またはユーザーidを指定できます。 | |
| initialObject |
|
オプション | 初期化時に、このチャットに関連付けるオブジェクトを指定できます。たとえば、連絡先からの「クリックしてチャット」アクションの際、その連絡先に関する情報をここに送信することができます。 |
リクエスト例
startChatButton.onclick = () => {
const chatChannel = chatChannelInput.値
const chatAddress = chatAddressInput.値
let associatedObject: InteractionAssociatedObject | undefined = undefined
const associatedObjectStr = associatedObjectTextarea.値
if (associatedObjectStr) {
try {
associatedObject = JSON.parse(associatedObjectStr)
} catch (e) {
alert('関連オブジェクトの構造に構文エラーがあります。JSONを解析できません。')
return
}
}
adApi.startChat(chatChannel as any, chatAddress, associatedObject)
}
戻り値
null