Chat App Message Service:Viber メッセージを送信する

パラメーター

タイプ

必須

説明

例

ChannelType

string

はい

チャネルのタイプ。パラメーターを viber に設定します。

viber

Type

string

はい

メッセージタイプ。有効な値：

• template：テンプレートメッセージ。テンプレートメッセージは、Chat App Message Service コンソールで作成および承認されたテンプレートに基づいて送信されます。テンプレートメッセージはいつでも送信できます。

• message：カスタムメッセージ。

template

MessageType

string

いいえ

メッセージの特定のタイプ。Type が message に設定されている場合の有効な値：

• text：テキストメッセージ。

• image：画像メッセージ。

• video：動画メッセージ。

• document：ドキュメントメッセージ。

• text_button：テキストとボタンメディアオブジェクトを含むメッセージ。

• text_image_button：テキスト、画像、ボタンなど、複数のメディアオブジェクトを含むメッセージ。

• text_video：テキストと動画メディアオブジェクトを含むメッセージ。

• text_video_button：テキスト、動画、ボタンなど、複数のメディアオブジェクトを含むメッセージ。

• text_image：テキストと画像メディアオブジェクトを含むメッセージ。

text

TemplateCode

string

いいえ

メッセージテンプレートのコード。このパラメーターは、Type パラメーターを template に設定した場合にのみ必須です。

744c4b5c79c9432497a075bdfca3****

Language

string

いいえ

メッセージテンプレートで使用される言語。このパラメーターは、Type パラメーターを template に設定した場合にのみ必須です。言語コードの詳細については、「言語コード」をご参照ください。

en

From

string

はい

メッセージ送信者の携帯電話番号。

2***9

To

string

はい

メッセージ受信者の携帯電話番号。

861390000****

TemplateParams

object

いいえ

メッセージテンプレートの変数。

string

いいえ

メッセージテンプレートに含まれる変数の値。値は JSON 形式である必要があります。テンプレートに変数が含まれている場合、このパラメーターは必須です。

{"param1":"value1","param2":"value2"}

Content

string

いいえ

メッセージの内容。

• messageType を text に設定した場合、text を指定する必要があります。

• messageType を image に設定した場合、link を指定する必要があります。

• messageType を video に設定した場合、link、thumbnail、fileSize、duration を指定する必要があります。

• messageType を document に設定した場合、link、fileName、fileType を指定する必要があります。

• messageType を text_button に設定した場合、text、caption、action を指定する必要があります。

• messageType を text_image_button に設定した場合、text、link、caption、action を指定する必要があります。

• messageType を text_video に設定した場合、text、link、thumbnail、fileSize、duration を指定する必要があります。

• messageType を text_video_button に設定した場合、text、link、thumbnail、fileSize、duration、caption を指定する必要があります。また、action を指定しないでください。

{"text": "hello whatsapp", "link": "", "caption": "", "fileName": "" }

FallBackId

string

いいえ

フォールバックポリシーの ID。Chat App Message Service コンソールでフォールバックポリシーを作成し、情報を表示できます。

S_000001

FallBackContent

string

いいえ

フォールバックメッセージの内容。

これはフォールバックメッセージです。

CustSpaceId

string

いいえ

RAM ユーザーのスペース ID。

28251486512358****

TrackingData

string

いいえ

Viber メッセージの追跡データ。

tracking_id:123456

Label

string

はい

Viber メッセージのタイプ。ChannelType が viber に設定されている場合、このパラメーターは必須です。有効な値：

• promotion

• transaction

promotion

Ttl

integer

いいえ

Viber メッセージを送信するためのタイムアウト期間。単位：秒。有効な値：30 ～ 1209600。

50

Tag

string

いいえ

Viber メッセージのタグ情報。

tag

TaskId

string

いいえ

タスク ID

100000001

FallBackDuration

integer

いいえ

メッセージがクライアントに配信されたことを示すメッセージ受信確認が受信されない場合に、フォールバックメッセージが送信されるまでの期間を指定します。このパラメーターを空のままにすると、メッセージの送信に失敗した場合、またはメッセージがクライアントに配信されなかったことを示すメッセージ受信確認が受信された場合にのみ、フォールバックメッセージが送信されます。単位：秒。有効な値：60 ～ 43200。

120

FallBackRule

string

いいえ

フォールバックルール。有効な値：

• undelivered：メッセージがクライアントに配信されない場合にフォールバックがトリガーされます。メッセージの送信時に、テンプレートパラメーターが検証されます。パラメーターが検証に合格しなかった場合、メッセージは送信されません。テンプレートと電話番号が禁止されているかどうかは検証されません。デフォルトでは、FallBackRule が空の場合にこの値が使用されます。

• sentFailed：変数を含むテンプレートパラメーターが検証に合格しなかった場合でも、フォールバックがトリガーされます。 channelType、type、messageType、to、from パラメーターが検証に合格しなかった場合、フォールバックはトリガーされません。

undelivered

パラメーター

タイプ

説明

例

object

返されるデータ。

RequestId

string

リクエストの ID。

90E63D28-E31D-1EB2-8939-A94866411B2O

Code

string

返されるステータスコード。

• OK の値は、リクエストが成功したことを示します。

• その他の値は、リクエストが失敗したことを示します。詳細については、「エラーコード」をご参照ください。

OK

Message

string

返されるエラーメッセージ。

指定されたリソースに対する操作がユーザーに許可されていません。

MessageId

string

送信されたメッセージの ID。

61851ccb2f1365b16aee****

HTTP ステータスコード

エラーコード

エラーメッセージ

400

Product.Unsubscript

指定されたプロダクトをサブスクライブしていません。

400

Ram.PermissionDeny

操作を実行する権限がありません。

400

System.LimitControl

システムはフロー制御中です。

400

Unknown.ResourceOwnerId

リソースは現在のユーザーに属していません。