SMS/MMS APIを使用することで、外部アプリケーションは、Bright Pattern プラットフォームのテキスト対応アクセス番号や、サポートされているメッセンジャー連携機能を通じてメッセージを送信することができます。また、このAPIを使用すると、使用されたチャネルに関係なく、これらのメッセージの配信状況を追跡することも可能です。
\n本書では、対応するREST APIメソッドについて、リクエストおよびレスポンスの例を交えて説明しています。このAPIは、Postman API開発環境に読み込んで、ご自身のアクセストークンを使用してAPIとやり取りすることができます。
\n以下の点にご注意ください：
\n200 OKのレスポンスでは、メッセージのステータスは常に「queued」と表示されます。実際の配信状況は、「メッセージの取得」メソッドを使用することで、若干の遅延を伴いますが確認可能です。API経由で送信されたメッセージに対する返信は、「メッセージの送信」リクエストの送信者ID（_From:_フィールド）で指定されたアクセス番号またはメッセンジャー連携に関連付けられたチャットサービスに転送される場合があります。返信の受信および処理が重要な場合は、サービス時間内にメッセージを送信し、サービス終了時刻のかなり前に送信を停止することをご検討ください。
\nサービス時間外に返信が受信された場合でも、シナリオを以下のように設定することで対応できます：
\n「メッセージ送信＋」シナリオブロックを使用して、サービス時間を顧客に案内する自動返信を送信する。
\nメッセージの内容を「メール」シナリオブロックにコピーし、翌日フォローアップできる担当者にこのメールを送信する。
\nUsername of a BP user authorized to use SMS/MMS API.
\n","type":"text"},{"key":"client_secret","value":"TeOrWMZ2hFfktGkdap5PLzAzknV9oICRqpfziHkAHc93rnZJZQ3W4aBLLn07LGki\n","description":"API secret key generated for the above user.
\n","type":"text"},{"key":"scope","value":"yourcompany.brightpattern.com","description":"Your contact center URL, e.g., example.brightpattern.com
\n","type":"text"},{"key":"grant_type","value":"client_credentials","description":"Grant type. Must be set to client_credentials.
\n","type":"text"}]},"url":"https://:tenant-url/configapi/v2/oauth/token","description":"このAPI経由で行われる以降の各リクエストの認証に使用されるアクセストークンを返します。
\n","urlObject":{"protocol":"https","port":"tenant-url","path":["configapi","v2","oauth","token"],"query":[],"variable":[{"type":"any","value":"yourcompany.brightpattern.com","key":"tenant-url"}]}},"response":[{"id":"0cb1ac4f-f9d8-4adf-92b5-9884906b3987","name":"Get Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"sasha","type":"text"},{"key":"client_secret","value":"FHjeyOt6LWS7jMvNb6tcjyuU3KDYlG2NjeI6vJBLV72VnLrwexA3imSkkQjSwLuv","type":"text"},{"key":"scope","value":"sasha.brightpattern.com","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":{"raw":"https:/:tenant-URL/configapi/v2/oauth/token","host":["https"],"port":"","path":[":tenant-URL","configapi","v2","oauth","token"],"variable":[{"key":"tenant-URL","value":"sasha.brightpattern.com"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"3600\",\n \"scope\": \"sasha.brightpattern.com\"\n}"}],"_postman_id":"4f7097c2-ff91-4dea-a491-883aad011a08"}],"id":"f1fc390b-6dee-4849-82c8-441fb434eb4e","description":"このAPIのクライアントを認証するために、OAuth 2.0 クライアント認証情報グラントが使用されます。認証されたユーザーが、要求された操作を実行するための適切な権限を持っているかどうかが確認されます。権限の完全なリストはこちらでご確認いただけます。権限は、1つまたは複数の役割を介してユーザーに割り当てられます。
\nアクセストークンを取得するには：
\nSMS、MMS、またはメッセンジャー連携メッセージを指定された宛先に送信します。
\nコンタクトセンターのドメイン名（例：example.brightpattern.com）。
\n","type":"text/plain"},"type":"any","value":"yourcompany.brightpattern.com","key":"tenant-url"}]}},"response":[{"id":"eb4710ab-be1a-4049-b25a-dc27e5fe2abd","name":"Send MMS Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"To\": \"+5219843111460\",\r\n \"Body\": \"Sending a test MMS message for BPCC SMS-MMS API.\",\r\n \"From\": \"16502505674\",\r\n \"MediaURLs\": \r\n [\r\n \"https://www.leithcars.com/assets/shared/CustomHTMLFiles/Responsive/MRP/Ford/2017/Mustang/images/2017-Ford-Mustang-01.jpg\"\r\n ]\r\n}"},"url":{"raw":"https:/:tenant-url/clientweb/smsapi/v1/Messages","host":["https"],"port":"","path":[":tenant-url","clientweb","smsapi","v1","Messages"],"variable":[{"key":"tenant-url","value":"sasha.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Wed, 06 Feb 2019 08:24:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"533"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"account_sid\": \"2B699762-370C-4F76-A684-A85B5F93DF84\",\n \"api_version\": \"1\",\n \"body\": \"Sending a test message for BPCC SMS-MMS API.\",\n \"num_segments\": \"1\",\n \"num_media\": \"0\",\n \"date_created\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"date_sent\": null,\n \"date_updated\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"direction\": \"outbound-api\",\n \"error_code\": null,\n \"error_message\": null,\n \"from\": \"16502505674\",\n \"price\": null,\n \"sid\": \"cbbb47e2-23be-452f-9b81-4a1f69300051\",\n \"status\": \"queued\",\n \"to\": \"16046496025\",\n \"uri\": \"/clientweb/smsapi/v1/Messages/cbbb47e2-23be-452f-9b81-4a1f69300051\"\n}"},{"id":"90c47ee5-82ba-42e2-8d4f-57154a350801","name":"Send Message with Only Mandatory Parameters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"To\": \"16046496025\",\r\n \"Body\": \"Sending a test message for BPCC SMS-MMS API.\",\r\n \"From\": \"16502505674\",\r\n \"MessagingService\": \r\n}"},"url":{"raw":"https:/:tenant-url/clientweb/smsapi/v1/Messages","host":["https"],"port":"","path":[":tenant-url","clientweb","smsapi","v1","Messages"],"variable":[{"key":"tenant-url","value":"sasha.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Wed, 06 Feb 2019 08:24:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"533"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"account_sid\": \"2B699762-370C-4F76-A684-A85B5F93DF84\",\n \"api_version\": \"1\",\n \"body\": \"Sending a test message for BPCC SMS-MMS API.\",\n \"num_segments\": \"1\",\n \"num_media\": \"0\",\n \"date_created\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"date_sent\": null,\n \"date_updated\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"direction\": \"outbound-api\",\n \"error_code\": null,\n \"error_message\": null,\n \"from\": \"16502505674\",\n \"price\": null,\n \"sid\": \"cbbb47e2-23be-452f-9b81-4a1f69300051\",\n \"status\": \"queued\",\n \"to\": \"16046496025\",\n \"uri\": \"/clientweb/smsapi/v1/Messages/cbbb47e2-23be-452f-9b81-4a1f69300051\"\n}"},{"id":"60f7f631-7ab6-4795-87bb-d1cb6183acce","name":"Send Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"To\": \"+5219843111460\",\r\n \"Body\": \"Test message 5\",\r\n \"From\": \"16502505674\"\r\n}"},"url":{"raw":"https://:tenant-url/clientweb/smsapi/v1/Messages","protocol":"https","port":"tenant-url","path":["clientweb","smsapi","v1","Messages"],"variable":[{"key":"tenant-url","value":"sasha.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Wed, 06 Mar 2019 20:22:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"506"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"account_sid\": \"2B699762-370C-4F76-A684-A85B5F93DF84\",\n \"api_version\": \"1\",\n \"body\": \"Test message 5\",\n \"num_segments\": \"1\",\n \"num_media\": \"0\",\n \"date_created\": \"Wed, 06 Mar 2019 20:22:33 +0000\",\n \"date_sent\": null,\n \"date_updated\": \"Wed, 06 Mar 2019 20:22:33 +0000\",\n \"direction\": \"outbound-api\",\n \"error_code\": null,\n \"error_message\": null,\n \"from\": \"16502505674\",\n \"price\": null,\n \"sid\": \"23e4f784-2ccb-446c-9c84-12277d3686c0\",\n \"status\": \"queued\",\n \"to\": \"+5219843111460\",\n \"uri\": \"/clientweb/smsapi/v1/Messages/23e4f784-2ccb-446c-9c84-12277d3686c0\"\n}"}],"_postman_id":"e569c43d-e49f-4861-b130-4506cc3a3a86"},{"name":"Get Message","id":"6b4be936-69d4-42ae-9f11-38b2afb1c717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"以前に送信されたSMSまたはMMSメッセージの現在のステータスを取得します。リクエストの時刻やネットワークの状態などによっては、次のいずれかのステータスが返される場合があります：キュー投入済み、送信済み、配信済み、失敗。
\n","urlObject":{"protocol":"https","path":["clientweb","smsapi","v1","Messages",":message-sid"],"host":["メッセージ識別子 - 「Send Message」リクエストが成功した際のレスポンスの「sid」パラメータから取得されます。
\n","type":"text/plain"},"type":"any","value":"","key":"message-sid"}]}},"response":[{"id":"ae2ada79-043a-4cc0-a048-4006a9fea1a5","name":"Get Status of Previously Sent Message","originalRequest":{"method":"GET","header":[],"url":{"raw":"https:/:tenant-url/clientweb/smsapi/v1/Messages/:message-sid","host":["https"],"port":"","path":[":tenant-url","clientweb","smsapi","v1","Messages",":message-sid"],"variable":[{"key":"tenant-url","value":"sasha.brightpattern.com"},{"key":"message-sid","value":"cbbb47e2-23be-452f-9b81-4a1f69300051"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Wed, 06 Feb 2019 09:26:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"531"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"account_sid\": \"2B699762-370C-4F76-A684-A85B5F93DF84\",\n \"api_version\": \"1\",\n \"body\": \"Sending a test message for BPCC SMS-MMS API.\",\n \"num_segments\": \"1\",\n \"num_media\": \"0\",\n \"date_created\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"date_sent\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"date_updated\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"direction\": \"outbound-api\",\n \"error_code\": null,\n \"error_message\": null,\n \"from\": \"16502505674\",\n \"price\": null,\n \"sid\": null,\n \"status\": \"delivered\",\n \"to\": \"16046496025\",\n \"uri\": \"/clientweb/smsapi/v1/Messages/cbbb47e2-23be-452f-9b81-4a1f69300051\"\n}"}],"_postman_id":"6b4be936-69d4-42ae-9f11-38b2afb1c717"}],"id":"449e75ce-e3ff-40cc-a5ba-5952cdedab00","description":"これらの方法により、SMSおよびMMSメッセージの送信や、配信状況の確認が可能になります。応答パラメータについては、以下で説明します。
\n