API基本情報
機能名 | SMS送信キャンセル | ||||||
リクエスト元 | ユーザー | ||||||
リクエスト先 |
『Karaden SMS API』 |
||||||
リクエスト方式 | POST | ||||||
リクエストContent-Type | application/x-www-form-urlencoded | ||||||
レスポンスContent-Type | application/json | ||||||
URL | /api/{tenant_id}/messages/{message_id}/cancel | ||||||
概要 | 送信リクエストを行ったメッセージのキャンセル。 SMS送信を受付後、未送信のメッセージのみ、処理5分前までキャンセル可能。 |
AUTHORIZATIONS | Bearer(必須) | トークン | |||||
PATH PARAMETERS
|
tenant_id(必須) | テナントID | |||||
message_id(必須) | メッセージID | ||||||
HEADER PARAMETERS | Karaden-Version(必須) | APIバージョン。 例)2023-01-01 |
リクエスト
・パラメーターなし
レスポンス
・パラメータは SMS送信 と同じ。