メインコンテンツへスキップ
POST
メッセージを転送

承認

Authorization
string
header
必須

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

ヘッダー

X-Device-Id
string

マルチデバイスサポート用のデバイス識別子 複数のデバイスが登録されている場合に必要です。 1つのデバイスのみ登録されている場合は、デフォルトとして使用されます。 device_idクエリパラメータとして提供することもできます。

例:

"my-device-id"

パスパラメータ

message_id
string
必須

チャットストレージからのソース メッセージ ID

ボディ

application/json

メッセージを送信する代わりにスケジュールする任意のフィールド。 スケジュールに scheduled_at を設定します。設定しないとすぐにメッセージが送信されます。

デバイスがオフラインまたはログインしていない間、バックグラウンドワーカーがスケジュールされた時間にそれを送信します。 アップロードされたメディアは、スケジュールが完了するまで サーバーに保存されます。 multipart/form-dataボディでは、weekdaysを繰り返すフィールド (weekdays=1、weekdays=3)として送ります。

phone
string
必須

宛先電話番号またはグループJID

例:

"6289685024051@s.whatsapp.net"

scheduled_at
string<date-time>

最初の送信のRFC3339時間。 将来的にする必要があります。 最初の送信は、たとえそれが weekdays や day_of_month の外であったとしても、この時に常に行われます。

例:

"2026-10-01T09:00:00+07:00"

timezone
string

IANA タイムゾーンは繰り返し実行を計算するために使用されます。 scheduled_at が設定されている場合に必要です。

例:

"Asia/Jakarta"

recurrence
enum<string>
デフォルト:once

繰り返し送信する頻度:

利用可能なオプション:
once,
daily,
weekly,
monthly
weekdays
integer[]

0=日曜日から6=土曜日に送信する日。 毎週繰り返しがある場合に必要です。

必須範囲: 0 <= x <= 6
例:
day_of_month
integer

月の日に送信するには、月の最後の日に締め付け。 毎月繰り返しの場合に必要です。

必須範囲: 1 <= x <= 31
例:

15

end_at
string<date-time>

繰り返しのみです。 送信はこの時間の後に行われません。scheduled_at の後にする必要があります。

例:

"2026-12-31T23:59:59+07:00"

occurrence_limit
integer

繰り返しのみです。 この多くの送信の後に停止します。

必須範囲: x >= 1
例:

10

duration
integer

オプションの消失メッセージの期間オーバーライド(0、86400、604800、7776000)

例:

0

force_reupload
boolean

メディア参照の再利用をスキップし、送信する前にメディアを再アップロードする

例:

false

レスポンス

OK

code
string
例:

"SUCCESS"

message
string
例:

"Success"

results
object