目次
送信元情報一覧取得APIとは
本APIの概要
送信元情報一覧取得APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことでb→dash管理画面上で登録した送信元情報を一覧で取得することができるAPIです。
配信施策系APIの利用に伴い、APIで送信元情報IDなどを取得したい場合は本APIを貴社開発環境にご開発ください。
21年12月時点でリリースしている配信系APIはメールアプリの「メール配信設定新規作成API」のみになるため、送信元情報一覧取得APIにおいて、メール以外のLINEやSMSの送信元情報を取得しても他APIでの活用は出来ないので注意しましょう。
本APIで取得できるb→dash管理画面上のデータ
b→dash管理画面と同等の操作
送信元情報一覧取得APIで一覧取得できる送信元情報は、以下のb→dash管理画面（「送信元情報一覧画面」「送信元情報詳細画面」）で確認できる情報を含む、「送信元情報ID」「送信元情報の名称」「送信元情報のアプリケーションカテゴリ」「送信元情報の種類」「送信元情報のステータス」の5項目になります。
本APIはアプリケーションのカテゴリごとに送信元情報の一覧を取得することができます。
送信元情報一覧画面-アプリケーションカテゴリ画面の例
送信元情報詳細画面の例
本API利用にあたっての前提事項
事前準備
送信元情報の設定
送信元情報一覧取得APIを利用する事前準備として、b→dash管理画面上で送信元情報の設定をする必要があります。
共通設定上で送信元設定のメールアドレスの登録がまだ完了していない場合は「送信元メールアドレスを設定したい」をご参照の上、登録を完了させてください。
非機能要件
送信元情報定義取得APIの非機能要件は、b→dash APIの共通仕様と同様です。共通仕様の詳細については「b→dash APIの共通仕様を知りたい」をご参照ください。
事前準備と非機能要件の確認ができましたら、送信元情報更新APIの利用方法について説明していきます！
送信元情報一覧取得APIの仕様
処理フロー図
送信元情報一覧取得APIの処理フロー図は以下になります。
送信元情報一覧取得リクエスト
送信元情報一覧取得APIのURIにURIパラメータを指定してデータ連携をリクエストするリクエストURIを準備します
〇送信元情報一覧取得APIのURI
| URI | https://api.smart-bdash.com/api/v1/sender_infos/{app_name} |
〇URIパラメータ
| プロパティ |
データ型
/サイズ |
必須 | 値 | 説明 |
| app_name |
string
/(指定値) |
○ | mail, sms, push |
送信元情報を取得したいアプリケーション
▽以下３通り ・『mail』: メール ・『sms』：SMS ・『push』：Push通知 |
【リクエストURIサンプル】
https://api.smart-bdash.com/api/v1/sender_infos/mailURIパラメータは、URIの「{xxx_xx}」に該当する値を代入することで指定することができます。
準備したリクエストURIと、下記のリクエストヘッダパラメータを用いて、貴社Webアプリから「GET」リクエスト形式で送信元情報一覧取得のリクエストをします
〇リクエスト形式
| HTTPメソッド | GET |
〇リクエストヘッダパラメータ
| プロパティ |
データ型
/サイズ |
必須 | 値 | 説明 |
| Authorization |
string
/2055byte |
◯ | Bearer {アクセストークン} | 「認証方式を選択したい」で取得したアクセストークン |
【リクエストコードサンプル】
GET https://api.smart-bdash.com/api/v1/sender_infos/mail送信元情報一覧取得レスポンス
リクエストの送信に成功すると、下記のレスポンス形式で送信元情報一覧が記載されたレスポンスが返されます
〇レスポンスボディパラメータ
| パラメータ名 | Key | データ型 | 説明 |
| 階層1：result | object | - | |
| 階層2：code | integer($int32) |
ステータスコード
・『200』：リクエスト成功 ・『400』：リクエストエラー |
|
| 階層2：sender_infos | object[] | 送信元情報の一覧 | |
| 階層3：id | string | 送信元情報のID | |
| 階層3：name | string | 送信元情報の名称 | |
| 階層3：app_name | string |
送信元情報のアプリケーションカテゴリ
・『mail』：メール ・『sms』：SMS ・『push』：Push通知 |
|
| 階層3：sender_info | string |
送信元情報の種類
・『メールアドレス』(メール) ・『電話番号』(SMS) ・『Channel ID』(LINE) ・『アプリ計測ID』(Push通知) |
|
| 階層3：status | integer($int32) |
送信元情報のステータス
・『1』：有効 ・『2』：無効 |
|
| 階層3：lastmodified | string |
送信元情報の最終更新日時
※yyyy/MM/dd hh24:mi:ss形式 |
【レスポンスボディサンプル】
{
"result": {
"code": 200,
"sender_infos": [
{
"id": "10001",
"name": "送信元情報Ａ",
"app_name": "mail",
"sender_info": "ABC@XXXXXXXXXX.com",
"status": 1,
"lastmodified": "2022/06/30 07:00:00"
},
{
"id": "10002",
"name": "送信元情報Ｂ",
"app_name": "mail",
"sender_info": "DEF@XXXXXXXXXX.com",
"status": 1,
"lastmodified": "2021/12/31 23:59:59"
}
]
}
}