送信データ
日次送信データ統計
日別のSMSデータ統計
URL
https://sms.api.engagelab.cc/v1/stats_day
https://sms.api.engagelab.cc/v1/stats_day
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
パラメーター説明
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
| time_zone | string | No | タイムゾーン。デフォルトタイムゾーン: +8 |
| template_ids | string | No | 複数のテンプレートIDを";"で区切る。例: template_ids=1;2;3、最大10個のテンプレートをサポート |
| sms_users | string | No | 特定のSMS_USERの統計を取得。";"で区切る。例: sms_users=a;b;c、最大10ユーザーをサポート |
| label_ids | string | No | SMSラベルIDリスト。";"で区切る。例: label_ids=123456;456789、最大10ラベルをサポート |
| start_date | string | Yes | 開始日（yyyy-MM-dd形式） |
| end_date | string | Yes | 終了日（yyyy-MM-dd形式） |
| msg_type | string | No | SMSタイプ。2は国際SMSを示す |
| aggregate_by | string | No | 集計するかどうか。0は集計しない、1は集計する。デフォルトは0 |
注意:
- クエリ期間は90日を超えてはなりません。
- aggregate_byが1の場合、データはmsg_typeごとに集計されます。aggregate_byが0の場合、集計は行われません。
リクエスト例
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| フィールド | 説明 |
|---|---|
| send_date | 送信日 |
| msg_type | SMSタイプ |
| sms_user | SMS_USER |
| template_id | SMSテンプレートID |
| label_id | ラベルID |
| targets | ターゲット総数 |
| sent | 送信数 |
| process_failed | 処理失敗数 |
| delivered | 配信数 |
| send_failed | 送信失敗数 |
| wait_result | 配信待ち数 |
| billing_count | 課金数 |
| process_failed_percent | 処理失敗率 |
| delivered_percent | 配信率 |
| send_failed_percent | 送信失敗率 |
| wait_result_percent | 配信待ち率 |
レスポンス例
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
このコードブロックはフローティングウィンドウ内に表示されます
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
このコードブロックはフローティングウィンドウ内に表示されます
処理失敗統計
処理失敗のカテゴリ別統計をクエリ
URL
https://sms.api.engagelab.cc/v1/stats/process_failed
https://sms.api.engagelab.cc/v1/stats/process_failed
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(smsUser:smsKey) |
パラメーター説明
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
| time_zone | string | No | タイムゾーン。デフォルトタイムゾーン: +8 |
| sms_users | string | No | 特定のSMS_USERの統計を取得。";"で区切る。例: sms_users=a;b;c、最大10ユーザーをサポート |
| start_date | string | Yes | 開始日（yyyy-MM-dd形式） |
| end_date | string | Yes | 終了日（yyyy-MM-dd形式） |
| msg_type | string | No | 業務タイプ。2は国際SMSを示し、デフォルトは2 |
| label_ids | string | No | SMSラベルIDリスト。";"で区切る。例: label_ids=123456;456789、最大10ラベルをサポート |
| template_ids | string | No | 複数のテンプレートIDを";"で区切る。例: template_Ids=1;2;3、最大10テンプレートをサポート |
| aggregate_by | string | No | 集計するかどうか。0は集計しない、1は集計する。デフォルトは0 |
注意:
- クエリ期間は90日を超えてはなりません。
- aggregate_byが1の場合、データはmsg_typeごとに集計されます。aggregate_byが0の場合、集計は行われません。
リクエスト例
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| フィールド | 説明 |
|---|---|
| send_date | 送信日 |
| label_id | ラベルID |
| msg_type | SMSタイプ |
| sms_user | SMS_USER |
| template_id | SMSテンプレートID |
| global_block | グローバルブロック数 |
| partial_block | 部分ブロック数 |
| unsubscribe | 配信停止数 |
| keyword_block | キーワードブロック数 |
| variable_error | 変数エラー数 |
| content_error | コンテンツ不適合数 |
| frequency_overrun | 頻度超過数 |
| other | その他数 |
レスポンス例
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
このコードブロックはフローティングウィンドウ内に表示されます
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
{
"result" : {
"msg_type" : "2",
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
このコードブロックはフローティングウィンドウ内に表示されます
送信失敗統計
送信失敗のカテゴリ別統計をクエリ
URL
https://sms.api.engagelab.cc/v1/stats/send_failed
https://sms.api.engagelab.cc/v1/stats/send_failed
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメーター説明
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
| time_zone | string | No | タイムゾーン。デフォルトタイムゾーン: +8 |
| sms_users | string | No | 特定のSMS_USERの統計を取得。";"で区切る。例: sms_users=a;b;c、最大10ユーザーをサポート |
| start_date | string | Yes | 開始日（yyyy-MM-dd形式） |
| end_date | string | Yes | 終了日（yyyy-MM-dd形式） |
| msg_type | string | No | SMSタイプ。2は国際SMSを示す |
| label_ids | string | No | SMSラベルIDリスト。";"で区切る。例: label_Ids=123456;456789、最大10ラベルをサポート |
| template_ids | string | No | 複数のテンプレートIDを";"で区切る。例: template_Ids=1;2;3、最大10テンプレートをサポート |
| aggregate_by | string | No | 集計するかどうか。0は集計しない、1は集計する。デフォルトは0 |
注意:
- クエリ期間は90日を超えてはなりません。
- aggregate_byが1の場合、データはmsg_typeごとに集計されます。aggregate_byが0の場合、集計は行われません。
リクエスト例
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| フィールド | 説明 |
|---|---|
| send_date | 送信日 |
| label_id | ラベルID |
| msg_type | SMSタイプ |
| sms_user | SMS_USER |
| template_id | SMSテンプレートID |
| empty | 空番号数 |
| out_of_service | サービス外数 |
| blacklist | ブラックリスト数 |
| busy | 忙しい数 |
| no_answer | 応答なし数 |
| interception | 遮断数 |
| break_down | 携帯故障数 |
| not_in_service | サービス外数 |
| power_off | 電源オフ数 |
| other | その他数 |
レスポンス例
aggregate_by=0
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
このコードブロックはフローティングウィンドウ内に表示されます
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
このコードブロックはフローティングウィンドウ内に表示されます
