SparkTG

APIドキュメントドキュメント

APIドキュメント

v1.0v2 へ移行中

SparkTG の API は v2 へ移行します

これらのページは API v1 の説明です。SparkTG のすべての API は、ユーザー名とパスワードの代わりに署名付き API トークンを使う API v2 へ移行します。v2 がある場合は v2 をご利用ください。

API v2 への移行

APIドキュメント

SparkTGクラウドテレフォニーAPIリファレンス

概要v1.0

SparkTG クラウドテレフォニー API

はじめに

SparkTGはクラウドテレフォニーサービスのプロバイダーです。クラウドテレフォニーとは、製品やサービスを提供する組織に対して、堅牢で信頼性の高いテレフォニー機能をオンデマンドで提供するサービスです。

ネットワークアクセス: 各機能はネットワーク経由で提供され、標準的な仕組みで利用できます。ユーザーはどこからでもログインして、ご自身のサービスを管理できます。

リソースプーリング: 通信リソースはマルチテナントモデルにより複数のお客様に提供するためプールされており、物理リソースと仮想リソースが需要に応じて動的に割り当て・再割り当てされます。これにより、自社でテレフォニーサービスを構築するコストを抑え、利用したリソースの分だけお支払いいただけます。

伸縮性: テレフォニーポートは迅速かつ柔軟に(場合によっては自動的に)プロビジョニングできるため、スケールアウトにすばやく対応でき、スケールインの際にも速やかに解放できます。

従量計測サービス: クラウドシステムは、サービスの種類に応じた適切な抽象度の計測機能(例:着信数、発信数、スパム通話数)により、リソースの使用状況を自動的に制御・最適化します。リソースの使用状況は監視、制御、レポートが可能で、サービスの提供者と利用者の双方に透明性をもたらします。こうした目的のもと、SparkTGは主要なサービスのほとんどにAPIを提供しており、お客様はWeb、デスクトップ、モバイルのアプリケーションで簡単に試用・統合できます。

前提条件

本ドキュメントは開発者向けであり、SparkTGクラウドテレフォニープラットフォームに関する基本的な知識を前提としています。お客様がアプリケーションでAPIを利用する前に、SparkTG側でお客様ごとにAPIサービスを事前にプロビジョニングする必要があります。

Basic認証ヘッダーの送信: SparkTGのAPIはBasic認証を使用するREST型APIです。Basic認証ヘッダーはお客様側で送信していただく必要があります。そのためには、username:passwordの形式の文字列を渡してください。

クラウドテレフォニー

堅牢な機能を組織に確実に提供するオンデマンドのテレフォニーサービス。ネットワーク経由でどこからでも利用できます。

リソースプーリング

動的なリソース割り当てを行うマルチテナントモデル。使った分だけお支払いいただくため、自社開発コストを削減できます。

伸縮性

テレフォニーポートを自動で迅速にプロビジョニングしてスケールアウトし、必要に応じてすばやく解放してスケールインできます。

従量計測サービス

計測機能による自動的なリソース制御。提供者と利用者の双方にとって透明性のある利用状況の監視が可能です。

Basic認証

Basic認証を使用するREST型APIです。Basic認証ヘッダーはお客様側で送信していただく必要があります。そのためには、username:passwordの形式の文字列を渡してください。

認証形式:

username:password

Authorizationヘッダーに指定するか、curlの-uフラグを使用してください

開発者向け要件

• SparkTG クラウドテレフォニープラットフォームに関する基本的な知識が必要です

• お客様ごとに、事前にSparkTGがAPIサービスをプロビジョニングする必要があります

• Basic認証をサポートするRESTベースのAPI

• Web、デスクトップ、モバイルアプリケーションに対応

はじめに

1. APIアクセスを申請

お客様のアカウントでAPIサービスを有効にするため、SparkTGにお問い合わせください。

2. 認証情報を取得

Basic認証用のusername:password形式の認証情報を受け取ります。

3. APIを選択

通話管理、エージェントAPI、メッセージングなどから選択します。

4. 連携

Web、デスクトップ、モバイルアプリケーションでRESTエンドポイントを使用します。

利用可能なAPIカテゴリ

エージェント管理

ログイン、ステータス、休憩、エージェント設定

通話管理

発信、転送、スケジュール設定、通話制御

メッセージングとOTP

SMSおよびOTP認証サービス

アナリティクス

通話履歴、レポート、ダッシュボードデータ

リアルタイムイベント

WebSocketイベントとWebhook連携

設定

転送設定とサービス設定