https://IoTCall.jp

API マニュアル

Ref 2024/01/17

1

API連携 ー APIでできること

APIでできること
あらかじめルールを作成いただくことで、お客様のシステムと連携して、下記のAPIをご利用いただけます。
1

ルール発動
APIを通じて手動発動同様、ルールを発動することができます。

2

電話番号一覧取得
APIを通じて、対象ルールの現在の電話番号一覧を取得できます。

3

電話番号の登録/更新/削除
APIを通じて、対象ルールへの電話番号の登録/更新/削除が行えます。（上書き）

4

履歴の取得
APIを通じて、アカウント/ルールごとの架電・SMS送信履歴の取得が行えます。

5

A ～

E

発動IDの取得
ユーザー管理画面内「管理者設定」にて、ルール発動通知先のお客様URLを指定することにより、ルールが発動された際、発動IDを通知します。

2

API連携 ー 事前準備
お客様システムでAPIをご利用になる前に下記ご準備をお願いします。
A お客様アカウントのAuthCodeの確認
例

C ルール内URLキーの確認
例「電話番号自動登録」 ar/URLキー/
または、「手動発動URL」mc/URLキー/を参照願います。

お客様管理画面（ダッシュボード）アカウント情報で確認いただけます。

B API対象のルールの作成◎ 「電話番号自動登録」は、「自動登録を行う」にチェックを入れてください。
この設定にて、電話番号の無記入でルールの保存（更新）が行えます。

◎ 「再生内容」は、「テキスト」にチェックを入れてください。
手動発動同様、APIではメールを取り扱いません。

◎ 「発信種別」は任意の設定で構いませんが、「通常」以外は2つ以上の電話番号登録が必要になります。

3

API連携 ー APIの種類
1

ルール発動
Http（s）
https://sys.iotcall.jp/pattern/URLキー/call2

METHODPOST

HEADERS

Authorization:AuthCode

電話番号一覧取得
Http（s）
https://sys.iotcall.jp/pattern/URLキー/tel
METHODGETHEADERS

Authorization:AuthCode4

API連携 ー APIの種類
3

電話番号の登録/更新/削除（上書き）Http（s）
https://sys.iotcall.jp/pattern/URLキー/tel

パラメータ [Text]= （必須）

METHOD

PUT

1tel

電話番号（ーなしの連番）

HEADERS

Authorization:AuthCode
Content-Type：application/x-www-form-urlencoded

2

group

電話番号のグループ（A～）

3

check

架電対象のチェック（あり：1 なし：0）

BODY Form

call_to_tels[0][tel][Text]=
call_to_tels[0][group][Text]=
call_to_tels[0][check][Text]=
call_to_tels[0][ international_prefix_id][Text]=

4

international_prefix_id

国番号（リスト順：1～）

ルール編集画面 電話番号登録項目でのパラメータ説明

1

複数電話番号を登録する場合は、電話番号分パラメータをセットする必要があります。

例

・1件目
call_to_tels[0][tel]call_to_tels[0][group]
call_to_tels[0][check]call_to_tels[0][international_prefix_id]
・2件目
call_to_tels[1][tel]call_to_tels[1][group]
call_to_tels[1][check]call_to_tels[1][international_prefix_id]
・3件目
call_to_tels[2][tel]call_to_tels[2][group]
call_to_tels[2][check]call_to_tels[2][international_prefix_id]

08043391234
1
1108043391235
2
0108043391236
3
1
1

3
番号

国

1

日本

2

アメリカ（本土）

3

アルゼンチン

4

イギリス

5

イタリア

2

4～

45

API連携 ー APIの種類
4

履歴の取得A ユーザーアカウントのすべての履歴を取得します。（URLキーの記入は不要です。）
Http（s）

Http（s）
https://sys.iotcall.jp/pattern/calllog

通話履歴METHODGETHEADERS

Authorization:AuthCode
Content-Type：application/x-www-form-urlencoded

通話履歴レスポンス例"status": "ok","list": [{"to": "+818043391234”,“status”: “completed”,“response_no”: 1,“duration”: “31”,"start_time": "2022-07-15 04:07:40","end_time": "2022-07-15 04:08:11",“memo”: “これはテストです。","rule_id": "0008200123“"code": "0015300264230816123459"},{"to": "+818043395678","status": "completed","response_no": null,"duration": "19","start_time": "2022-07-15 04:14:57","end_time": "2022-07-15 04:15:16","memo": "これはテストです。","rule_id": "0008200456“"code": "0015300264230816123559"},

https://sys.iotcall.jp/pattern/smslog

SMS送信履歴レスポンス例{]}

SMS送信履歴{"status": "ok","list": [{"to": "+8180433990123","status": "delivered","created_at": "2022-07-15 03:54:41","memo": "これはテストです。","rule_id": "0008200123“"code": "0015300264230816556459"},{"to": "+818043394567","status": "delivered","created_at": "2022-07-15 04:07:35","memo": "これはテストです。","rule_id": "0008200456“"code": "0015300264234456123459"
},
]

荷電先
通話完了
応答番号
通話時間（秒）
通話開始時間
通話終了時間
備考
ルールID
ルール発動ID

送信先
送信完了
送信日時
備考
ルールID
ルール発動ID}

ルール発動IDとは、そのルールが発動されたIDです。
ルールID＋年下2桁＋月2桁＋日2桁＋時2桁＋日2桁＋秒2桁

6

API連携 ー APIの種類
4

履歴の取得
B

特定のルールのすべての履歴を取得します。（URLキーの記入は必要です。）
Http（s）

Http（s）
通話履歴

https://sys.iotcall.jp/pattern/URLキー/calllog
METHODGETHEADERS

Authorization:AuthCode
Content-Type：application/x-www-form-urlencoded

レスポンスの内容はC

SMS送信履歴https://sys.iotcall.jp/pattern/URLキー/smslog

A 同様です。

特定のルールの直近の発動された履歴を取得します。（URLキーの記入は必要です。）
Http（s）

Http（s）
通話履歴

https://sys.iotcall.jp/pattern/URLキー/calllog/latest

SMS送信履歴

METHODGETHEADERS

Authorization:AuthCode
Content-Type：application/x-www-form-urlencoded

https://sys.iotcall.jp/pattern/URLキー/smslog/latest

最新の発動履歴の取得には、発動されてから10分程度必要です。

レスポンスの内容は

A 同様です。

7

API連携 ー APIの種類
4

履歴の取得
D

A・Bに対し、日時の範囲指定ができます。
Http（s）

ルールごとの通話履歴

https://sys.iotcall.jp/pattern/URLキー/calllog?start_datetime=年月日時刻&end_datetime=年月日時刻

ルールごとのSMS送信履歴

https://sys.iotcall.jp/pattern/URLキー/smslog?start_datetime=年月日時刻&end_datetime=年月日時刻

METHODGETHEADERS

Authorization:AuthCode
Content-Type：application/x-www-form-urlencoded

BODY Form

パラメータ
start_datetime=
end_datetime=例2023-11-30 00:00:00
2023-11-30 23:59:59

年月日と時刻の間は半角スペース

・ start_datetime および end_datetime は両方および片方の利用が可能です。
・ 年月日のみの指定も可能です。

8

API連携 ー APIの種類4

履歴の取得
E

発動IDを指定することにより、通話およびSMS送信履歴が取得できます。
Http（s）

発動IDごとの通話およびSMS送信履歴

https://sys.iotcall.jp/pattern/URLキー/発動IDMETHODGETHEADERS

Authorization:AuthCode
Content-Type：application/x-www-form-urlencoded

発動IDは、 5 発動IDの取得 にて取得できます。

例{"status": "ok","0": {
SMS送信履歴 “sms_logs”: [架電履歴 “call_logs”: [{{“to”: “+818043390123”,← 電話番号“to”: “+818043390123”,← 電話番号“status”: “delivered”,← 送信完了“status”: “completed”,← 架電完了“created_at”: “2022-07-15 04:14:51”, ← 送信時間
“response_no”: null,← プッシュボタン返信なし“memo”: “”,← メモなし“duration”: “19”,← 通話時間“rule_id”: “0008200123”,← ルールID“start_time”: “2022-07-15 04:14:57”, ← 通話開始時間“code”: “0008200149220715041448” ← 発動ID
“end_time”: “2022-07-15 04:15:16”, ← 通話終了時間}“memo”: “”,← メモなし],“rule_id”: “0008200123”,← ルールID“code”: “0008200149220715041448“ ← 発動ID}]}}9API連携 ー APIの種類
5

発動IDの取得
ユーザー管理画面内「管理者設定」にて、ルール発動通知先のお客様URLを指定することにより、ルールが発動された際、発動IDを通知します。

例

ここで取得した発動IDを転用し、履歴が取得できます。

4

履歴の取得
発動IDを指定することにより、通話およびSMS送信履歴が取得できます。

10

API連携 ー APIテストについて
APIテストについて
下記にて、Chromeブラウザ環境でAPIのテストを行うことができます。

1

Chromeプラグイン「Talend API Tester - Free Edition」を追加

https://chrome.google.com/webstore/detail/talend-api-tester-free-ed/aejoelaoggembcahagimdiliamlcdmfm?hl=ja2

API対象のルールを作成（P.3 Bを参照）

3

各APIのテストを行います。

Talend API Tester - Free Edition

11

サービスに関するお問合せ先

株式会社ハイパーボックス
ドメインキーパー事業部ソリューション課
IoTコール 係

https://www.iotcall.jp/contact.html
03-5304-8161
ボリュームディスカウントや代理店契約、貴社提供サービスプラン企画など可能です。
お気軽にご相談ください。

12