API docs by Redocly

絶対リーチ！RCS API仕様書 (1.0.0)

Download OpenAPI specification:

本番環境URL

本APIの本番環境エンドポイントは以下のURLでご利用いただけます。

https://richrcs-api.serv.aixmsg.com

改版履歴

  • 2025-10-01 v1.0.0: 初版発行

メッセージ送信API

RCS/SMSメッセージの送信を受け付けます。

送信方式

  1. テンプレート送信: 事前に登録したテンプレートを使用
  2. 通常送信: メッセージを直接指定

制限事項

メッセージ共通

  • 宛先数: 最大5000件（RCS/SMS共通）
  • 電話番号の重複: 不可（DuplicatedPhoneNumberでエラー）
  • ショートURLの書式: {{#URL#}}
    例: {{#https://example.com#}}

RCSテキスト

  • 本文: 最大2730文字
  • 添付ファイル: 最大1件
  • ショートURL: 合計5件まで（配信停止URL・ダウンロードURLも含む）
  • チャットボット: 最大1件

RCSリッチカード

  • タイトル: 最大200文字
  • 説明文: 最大2000文字
  • ※管理画面の「データ管理」>「テンプレート」>「テンプレート作成」におけるチェック内容に従う。

SMS

  • 本文: 最大660文字
  • ショートURL: 合計5件まで（配信停止URL・ダウンロードURLも含む）

注意事項

  • 予約送信は未来日時のみ指定可能です
  • 電話番号は重複指定できません（重複時は「DuplicatedPhoneNumber」エラーが発生）
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能

クライアントID取得方法

管理画面（ https://rcs.serv.aixmsg.com ）にログインすると、 URLのクエリパラメータに含まれています。 例: https://rcs.serv.aixmsg.com/?clientId=1&botId=TEST1 → clientId=1 の「1」がクライアントID

botId
required
string

ボットID

  • 配信設定単位に管理するID
  • クライアントに紐づく有効なボットIDのみ利用可能

ボットID取得方法

管理画面（ https://rcs.serv.aixmsg.com ）にログインすると、 URLのクエリパラメータに含まれています。 例: https://rcs.serv.aixmsg.com/?clientId=1&botId=TEST1 → botId=TEST1 の「TEST1」がボットID

Request Body schema: application/json
required
templateId
string

テンプレートID ※テンプレート送信時は必須

sendTaskName
required
string [ 1 .. 50 ] characters

送信タスク名

apiType
number
Enum: 1 2 3 4

【送信方式】
1: RCS＋SMS
2: RCSのみ
3: SMSのみ
4: RCS＋SMS（SoftBankはSMSのみ）
※通常送信時は必須

required
Array of objects [ 1 .. 5000 ] items

宛先情報

  • 最小1件、最大5000件（RCS/SMS共通）
  • 重複した電話番号は指定不可（エラーコード: duplicated_phone_number）
smsText
string [ 1 .. 660 ] characters

SMSメッセージ本文

  • 最大660文字まで
  • apiTypeが1,3,4の場合は必須
  • URLを短縮URLに変換するには、{{#URL#}}形式で記述する必要があります。
    例: 「こちらをクリック: {{#https://example.com#}}」
  • 短縮URLは1メッセージあたり合計5件まで指定可能です。
  • 配信停止URL（OPTOUT）とダウンロードURL（DWLOAD）も合計5件の制限にカウントされます。
    （例：配信停止URLとダウンロードURLを使用する場合、ユーザーが指定できる短縮URLは最大3件）
    ※{{#URL#}}形式で記述されていないURLは短縮されず、そのままの形式で送信されます。
rcsText
string [ 1 .. 2730 ] characters

RCSメッセージ本文

  • 最大2730文字まで
  • apiTypeが1,2,4の場合は必須
  • URLに関する制約はsmsTextと同様です
scheduledTime
string^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}...

配信予約日時（JST）

  • フォーマット: YYYY-MM-DD HH:MM
  • 過去の日時は指定不可
  • 分単位での指定（秒は指定不可） 例: "2024-03-20 15:00"
Array of objects (Attachments) <= 1, items

SMSテキスト、RCSテキストの添付ファイル

Array of objects (Chatbots) <= 1, items

SMSテキスト、RCSテキストのチャットボットURL

Responses

Request samples

Content type
application/json
Example
{
  • "sendTaskName": "Task1",
  • "apiType": 1,
  • "dest": [
    ],
  • "smsText": "SMSメッセージ 差し込み1:{{$option1$}} 差し込み2:{{$option2$}}",
  • "rcsText": "RCSメッセージ 差し込み1:{{$option1$}} 差し込み2:{{$option2$}}",
  • "textAttachments": [
    ],
  • "textChatbots": [
    ]
}

Response samples

Content type
application/json
{
  • "sendTaskName": "Task1",
  • "apiType": 1,
  • "dest": [
    ],
  • "smsText": "こちらがSMSメッセージです。",
  • "textAttachments": [
    ],
  • "textChatbots": [
    ],
  • "broadcastId": "broadcastId_12238047-0b56-4d3d-ad52-212fb4deea5e",
  • "status": "ACCEPTED"
}

配信結果検索API

指定した条件に合致する配信結果を検索します

検索条件

  • 送信開始日時範囲
  • 受付日時範囲
  • 配信ステータス

制限事項

  • 未来日時は指定不可
  • 日付範囲は最大1年間
  • 1回のリクエストで最大100件まで取得可能
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能
botId
required
string

ボットID

  • 配信設定単位に管理するID
  • クライアントに紐づく有効なボットIDのみ利用可能
Request Body schema: application/json
required
sendStartTimeFrom
string <iso-date-time-with-timezone>

送信開始日時の開始日時（ISO8601形式 UTCまたはタイムゾーンオフセット付き） 例: "2024-01-01T00:00:00Z", "2024-01-01T09:00:00+09:00"

sendStartTimeTo
string <iso-date-time-with-timezone>

送信開始日時の終了日時（ISO8601形式 UTCまたはタイムゾーンオフセット付き） 例: "2024-01-02T00:00:00Z", "2024-01-02T09:00:00+09:00"

acceptedTimeFrom
string <iso-date-time-with-timezone>

送信依頼を受け付けた日時の開始日時（ISO8601形式 UTCまたはタイムゾーンオフセット付き） 例: "2024-01-01T00:00:00Z", "2024-01-01T09:00:00+09:00"

acceptedTimeTo
string <iso-date-time-with-timezone>

送信依頼を受け付けた日時の終了日時（ISO形式UTC） 例: "2024-01-31T23:59:59Z"

status
string
Enum: "SCHEDULED" "ACCEPTED" "ENROUTE" "SENT" "INACTIVE" "APPROVAL_REJECTED" "APPROVAL_PENDING"

配信ステータス

  • SCHEDULED: 予約中
  • ACCEPTED: 受付済み
  • ENROUTE: 送信処理開始
  • SENT: 送信済み
  • INACTIVE: 配信不可
  • APPROVAL_REJECTED: 承認却下
  • APPROVAL_PENDING: 承認待ち
limit
number [ 1 .. 100 ]
Default: 100

レスポンス上限（1〜100） デフォルト: 100

offset
number >= 0
Default: 0

ページングのoffset

Responses

Request samples

Content type
application/json
{
  • "status": "SENT",
  • "sendStartTimeFrom": "2022-01-01T00:00:00Z",
  • "sendStartTimeTo": "2022-01-12T00:00:00Z",
  • "acceptedTimeFrom": "2023-01-01T00:00:00Z",
  • "acceptedTimeTo": "2023-01-12T00:00:00Z",
  • "limit": 10,
  • "offset": 30
}

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "templateId": "templateId_550e8400-e29b-41d4-a716-446655440000",
  • "items": [
    ]
}

送信結果検索API

指定したブロードキャストIDの送信結果を検索します。

主な機能

  • ブロードキャストIDに紐づく送信結果の詳細を取得
  • 電話番号やステータスによる絞り込み
  • ページング機能によって大量データも効率的に取得可能

制限事項

  • 1回のリクエストで取得可能な上限は100件
  • デフォルトの取得件数は100件
  • offsetは0以上の整数

注意事項

  • 非アクティブなクライアントは利用不可
  • 存在しないボットIDは指定不可
  • 存在しないブロードキャストIDは指定不可
  • 電話番号は国内形式（ハイフンなし11桁）で指定
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能
botId
required
string

ボットID

  • 配信設定単位に管理するID
  • クライアントに紐づく有効なボットIDのみ利用可能
broadcastId
required
string

ブロードキャストID

  • 送信タスク毎に発行される一意のID 例: broadcastId_81f3b88c-8a40-4aed-b2aa-552a36e643abc
Request Body schema: application/json
optional
status
string
Enum: "ENROUTE" "DELIVRD" "UNDELIV" "DISPLAYED" "CANCELED" "REJECTED"

送信状況

  • ENROUTE: 送信中
  • DELIVRD: 送達
  • UNDELIV: 送信失敗
  • DISPLAYED: 開封済
  • CANCELED: 送信キャンセル
  • REJECTED: 送信除外
phoneNumber
string^(070|080|090|060|020)[0-9]{8}$

宛先電話番号（国内電話番号形式）

  • ハイフンなしの11桁
  • 070/080/090/060/020から始まる番号のみ 例: 09012345678
messageType
string
Enum: "SMS" "RCS"

メッセージの種類

  • SMS: SMSメッセージ
  • RCS: RCSメッセージ
limit
integer [ 1 .. 100 ]
Default: 100

1回のリクエストでの取得上限件数

  • 1から100までの整数
  • 指定がない場合は100として扱う
offset
integer >= 0
Default: 0

取得開始位置

  • 0以上の整数
  • 指定がない場合は0として扱う
  • ページング処理に使用

Responses

Request samples

Content type
application/json
{
  • "status": "DISPLAYED",
  • "phoneNumber": "09012345678",
  • "messageType": "RCS",
  • "limit": 10,
  • "offset": 30
}

Response samples

Content type
application/json
{
  • "totalCount": 1,
  • "templateId": "templateId_550e8400-e29b-41d4-a716-446655440000",
  • "textAttachments": [
    ],
  • "textChatbots": [
    ],
  • "items": [
    ]
}

受信メッセージ検索API

指定した電話番号の受信メッセージを検索します。

主な機能

  • 指定した電話番号の受信メッセージを時系列で取得
  • テキストメッセージと添付ファイルの両方に対応
  • ページング機能によって大量データも効率的に取得可能

制限事項

  • 未来日時は指定不可
  • 開始日時は終了日時より前である必要あり
  • 1回のリクエストで取得可能な上限は100件
  • デフォルトの取得件数は100件
  • offsetは0以上の整数

注意事項

  • 非アクティブなクライアントは利用不可
  • 存在しないボットIDは指定不可
  • 日時はすべてUTC（ISO 8601形式）で指定
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能
botId
required
string

ボットID

  • 配信設定単位に管理するID
  • クライアントに紐づく有効なボットIDのみ利用可能
phoneNumber
required
string^0[789]0[0-9]{8}$

電話番号

  • ハイフンなしの11桁
  • 070/080/090/060/020から始まる番号のみ 例: 09012345678
Request Body schema: application/json
optional
receiveTimeFrom
string <iso-date-time-with-timezone>

受信日時の開始日時（ISO 8601形式。タイムゾーン指定可能）

  • 未来日時は指定不可
  • UTC指定例: "2024-03-01T00:00:00Z"
  • タイムゾーン指定例: "2024-03-01T09:00:00+09:00"
receiveTimeTo
string <iso-date-time-with-timezone>

受信日時の終了日時（ISO 8601形式。タイムゾーン指定可能）

  • 未来日時は指定不可
  • 開始日時より後の日時を指定
  • UTC指定例: "2024-03-20T23:59:59Z"
  • タイムゾーン指定例: "2024-03-20T23:59:59+09:00"
limit
integer [ 1 .. 100 ]
Default: 100

1回のリクエストでの取得上限件数

  • 1から100までの整数
  • 指定がない場合は100として扱う
offset
integer >= 0
Default: 0

取得開始位置

  • 0以上の整数
  • 指定がない場合は0として扱う
  • ページング処理に使用

Responses

Request samples

Content type
application/json
{
  • "receiveTimeFrom": "2024-10-01T09:14:50.165Z",
  • "receiveTimeTo": "2024-10-28T09:14:50.165Z",
  • "limit": 10
}

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "items": [
    ]
}

月別レポート取得API

指定した年月の課金通数を取得します

取得可能なデータ

  • rcsChargesCount: RCSメッセージ送信従量費用
  • smsChargesCount: SMSメッセージ送信従量費用
  • solnRcsChargesCount: RCSソリューション送信従量費用（チャットボット・ダウンロード機能含む）
  • solnSmsChargesCount: SMSソリューション送信従量費用（チャットボット・ダウンロード機能含む）
  • fbSmsChargesCount: SMSメッセージ送信従量費用（SMSフォールバック分）
  • solnFbSmsChargesCount: SMSソリューション送信従量費用（チャットボット・ダウンロード機能含む）（SMSフォールバック分）
  • rcsDisplayedCount: RCS既読通数（RCSのみ既読ステータス対応、SMSは既読ステータス非対応）

合計通数の計算方法

  • RCS課金通数合計 = rcsChargesCount + solnRcsChargesCount
  • SMS課金通数合計 = smsChargesCount + solnSmsChargesCount + fbSmsChargesCount + solnFbSmsChargesCount

※ 各項目は個別の値で返却されるため、合計が必要な場合は上記計算式で算出してください。

制限事項

  • 未来の年月は指定不可
  • 前日までの送達数が集計されます。日が経過すると送達が増えることがあります。
  • 代理店の場合、配下クライアントの集計も取得可能
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能
Request Body schema: application/json
required
yymm
required
string\d{6}$

集計対象年月（YYYYMM形式） 例: "202403" (2024年3月)

withUnderAgency
boolean
Default: false

代理店配下の集計を含めるかどうか

  • true: 配下クライアントの集計も含める
  • false: 指定クライアントのみ集計（デフォルト）

Responses

Request samples

Content type
application/json
Example
{
  • "yymm": "202408"
}

Response samples

Content type
application/json
Example
{
  • "rcsChargesCount": 100,
  • "rcsDisplayedCount": 50,
  • "smsChargesCount": 200,
  • "solnRcsChargesCount": 30,
  • "solnSmsChargesCount": 40,
  • "fbSmsChargesCount": 15,
  • "solnFbSmsChargesCount": 10
}

URLクリック数取得API

指定したURLのクリック数を取得します

取得条件

  • ブロードキャストID
  • URL
  • 電話番号（オプション）

制限事項

  • 電話番号は070/080/090/060/020から始まる11桁の番号
  • 1回のリクエストで最大100件まで取得可能
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能
botId
required
string

ボットID

  • 配信設定単位に管理するID
  • クライアントに紐づく有効なボットIDのみ利用可能
Request Body schema: application/json
required
broadcastId
required
string^broadcastId_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]...

ブロードキャストID 例: "broadcastId_81f3b88c-8a40-4aed-b2aa-552a36e643abc"

url
required
string <uri>

クリック数を集計するURL 例: "https://example.com/campaign"

phoneNumber
Array of strings[ items^(070|080|090|060|020)[0-9]{8}$ ]

電話番号による絞り込み（指定しない場合は全件）

  • 070/080/090/060/020から始まる11桁の番号
  • ハイフンなし
limit
number

レスポンスの上限数（1〜100）

offset
number

ページングのオフセット

Responses

Request samples

Content type
application/json
{
  • "broadcastId": "broadcastId_81f3b88c-8a40-4aed-b2aa-552a36e643abc",
  • "phoneNumber": [
    ],
  • "url": "https://test.com"
}

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "items": [
    ]
}

予約配信キャンセルAPI

指定した予約配信をキャンセルします。

制限事項

  • 予約中の配信のみキャンセル可能

注意事項

  • 非アクティブなクライアントは利用不可
  • 存在しない一括配信IDは指定不可
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能
botId
required
string

ボットID

  • 配信設定単位に管理するID
  • クライアントに紐づく有効なボットIDのみ利用可能
broadcastId
required
string

一括配信ID

  • 配信毎に発行される一意のID

Responses

Response samples

Content type
application/json
{
  • "botId": "TEST-001",
  • "broadcastId": "broadcastId_12238047-0b56-4d3d-ad52-212fb4deea5e",
  • "sendTaskName": "送信タスク名",
  • "scheduledTime": "2025-06-07T14:25.00.000Z"
}

チャットボット回答結果取得API

指定したシナリオIDのチャットボット回答結果を取得します。

主な機能

  • シナリオIDに紐づくチャットボット回答結果の一覧を取得
  • ブロードキャストIDやステータスによる絞り込み
  • ページング機能によって大量データも効率的に取得可能

制限事項

  • 1回のリクエストで取得可能な上限は100件
  • デフォルトの取得件数は100件
  • offsetは0以上の整数
Authorizations:
x-token
path Parameters
clientId
required
string

クライアントID

  • 顧客毎に発行される一意のID
  • アクティブな状態のクライアントのみ利用可能
botId
required
string

ボットID

  • 配信設定単位に管理するID
  • クライアントに紐づく有効なボットIDのみ利用可能
scenarioId
required
string

シナリオID

  • シナリオ毎に発行される一意のID
Request Body schema: application/json
required
broadcastId
string

配信依頼ごとに割り振られる一意のID (GUID形式)

scenarioStatus
string
Enum: "read" "inprogress" "end"

シナリオ状況

  • read: 既読
  • inprogress: 回答中
  • end: 回答完了
phoneNumber
string^(070|080|090|060|020)[0-9]{8}$

宛先電話番号（国内電話番号形式）

  • ハイフンなしの11桁
  • 070/080/090/060/020から始まる番号のみ 例: 09012345678
limit
integer [ 1 .. 100 ]
Default: 100

1回のリクエストでの取得上限件数

  • 1から100までの整数
  • 指定がない場合は100として扱う
offset
integer >= 0
Default: 0

取得開始位置

  • 0以上の整数
  • 指定がない場合は0として扱う
  • ページング処理に使用

Responses

Request samples

Content type
application/json
{
  • "broadcastId": "broadcastId_12238047-0b56-4d3d-ad52-212fb4deea5e",
  • "scenarioStatus": "end",
  • "phoneNumber": "09012345678",
  • "limit": 10,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "totalCount": 3,
  • "botId": "botId_12238047-0b56-4d3d-ad52-212fb4deea5e",
  • "scenarioId": "scenarioId_12238047-0b56-4d3d-ad52-212fb4deea5e",
  • "items": [
    ]
}