Messageパート翻訳

英語版仕様書(オフィシャル)

https://docs.cmtelecom.com/en/api/messages/v1/index/

 

Messageパートは一度に複数の宛先に送信する場合やショートリンクなどオプション機能を利用する場合に最適なAPIとなります。

一通一通、大量メッセージの配信をご想定の場合には本資料内上部Business messaging パートをご覧ください。

Business messaging パートはこちら https://docs.google.com/document/d/1wc7OXjtJLjweyOVuhTKwZDuOIh_PhkkdDIb0D5wgTzA/edit#heading=h.rq93ba7fllij

 

また、英語版に記載のある項目で、翻訳されていない箇所もございますので、日本語版は参考程度にご覧ください。 

 

SMS認証専用APIの翻訳は以下をご覧ください

SMS認証API仕様書


1,Introduction/はじめに

CM’s Messages API enables you to send message campaigns to groups of recipients.

For individual and transactional messages, using the Business Messaging API is the preferred method. This Messages API is especially meant to send similar messages to a large group of recipients.

Messages API has some extra features which Business Messages api does not offer. You can check table below for features and suggested api.

このパートはグループに対して同じメッセージを配信したりキャンペーンを配信するAPIです。

個々のトランザクションメッセージの場合、Business Messaging APIを使用することをお勧めします。このメッセージAPIは、同様のメッセージを多数の受信者グループに送信することを特に目的としています。

メッセージAPIには、ビジネスメッセージAPIが提供しないいくつかの追加機能があります。以下の表で機能と推奨APIを確認できます

Feature機能

Suggested Api 利用するAPI

Automatically Shorten URLs 短縮URLの自動化(CMURL)

Messages API

OptOut / Unsubscribe オプトアウト機能

Messages API

Schedule Messages 配信予定

Messages API

Send CM Landing Page CMランディングページ追加

Messages API

Send Personalized Messages to a group of recipients

宛先ごと個別化されたメッセージ配信

Messages API

Send Event Notifications (Triggered messages)

Triggered メッセージ

Messages Api

No throttling 1通1通配信

Business Messaging API

Encryption (configuration required)暗号化

Business Messaging API

The Messages API is a REST API that uses JSON to communicate.

In getting started section current API functionality is described briefly. Some features like Analytics,Advanced Spread settings will be described separately.

メッセージAPIは、JSONを使用して通信するREST APIです。

入門セクションでは、初期リリース内の現在のAPI機能について簡単に説明します。 AnalyticsRecurrenceAdvanced Spread設定などの一部の機能は後で利用可能になりますが、リクエスト/レスポンスモデルに含まれています。

Authentication/認証

Authentication and authorization is done via a product token. You can obtain your product token from the messaging gateway app (https://www.cm.com/app/gateway/). If you don’t see that app you might have got it via your account manager or you can contact support to obtain one.

For all methods described in this api, the product token should be provided by including it in the X-CM-PRODUCTTOKEN header.

認証と承認は、製品トークンを介して行われます。 メッセージングゲートウェイアプリ(https://gateway.cmtelecom.com)からプロダクトトークンを取得できます。 そのアプリが表示されない場合は、使い方ガイドをご覧いただくか、担当に連絡してください。

このAPIで説明されているすべてのメソッドについて、X-CM-PRODUCTTOKENヘッダーに含めることでプロダクトトークンを提供する必要があります。

Getting your accountID/アカウントIDの取得

In all methods you need to provide the accountID. This is a guid that identifies your account. This identifier can be found on the url of the addressbook application (https://www.cm.com/app/addressbook/), after the language indicator. Below you can find some url examples and the corresponding accountID.

すべての方法で、accountIDを提供する必要があります。 これは、アカウントを識別するガイドです。 この識別子は、アドレス帳アプリケーションのURLhttps://addressbook.cmtelecom.com)の言語インジケーターの後にあります。 以下に、いくつかのURLの例と対応するaccountIDを見つけることができます。

Url

AccountID

https://www.cm.com/app/gateway/a66b6ba2-7b13-4caf-abf6-c736c977c1d4

a66b6ba2-7b13-4caf-abf6-c736c977c1d4

https://www.cm.com/app/campaigns/fe266716-d8ff-4aba-bddb-c61f8f40c656

fe266716-d8ff-4aba-bddb-c61f8f40c656

Getting Started/入門セクション

In below section current API functionality within initial release is described briefly. Some features like Analytics, Recurrence, Advanced Spread settings will be available later but they are included in request/response models.

 

以下のセクションでは、初期リリース内の現在のAPI機能について簡単に説明します。 AnalyticsRecurrenceAdvanced Spread設定などの一部の機能は後で利用可能になりますが、リクエスト/レスポンスモデルに含まれています。

1 – How to send a basic message/メッセージの配信方法

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages

POST/messages/v1/accounts/{accountId}/messages

Example post body:

{

“body”: “This is a test message”,

“recipients”: [

                 { “group”: “b99f6d4f-243a-11e7-9742-005056b0187a” },

                 { “contact”: “0b7bf29a-2439-11e7-9742-005056b0187a” },

                 { “msisdn”: “+31765727000” }

               ],

“senders”: [“TEST”]

}

 recipients : Contains an array of recipient objects, for any given phone number msisdn must be specified. If you want to send to Addressbook groups/contacts you need to specify the guids.

senders : Contains an array of string(s), specifies the message sender.

 Message will be sent immediately.

recipients:受信者オブジェクトの配列が含まれます。任意の電話番号に対してmsisdnを指定する必要があります。 アドレス帳グループ/連絡先に送信する場合は、guidを指定する必要があります。

senders:文字列の配列が含まれ、メッセージの送信者を指定します。

メッセージはすぐに送信されます。

 


Example curl request :

curl -X POST \

  https://api.cm.com/messages/v1/accounts/z9761684-b8d0-440f-8508-72ec36766069/messages \

  -H ‘Accept: application/json, text/json’ \

  -H ‘Content-Type: application/json’ \

  -H ‘X-CM-PRODUCTTOKEN: ce4e6c52-5696-405b-9524-e478468f1907’ \

  -d ‘{

    “body”: “This is a test message”,

    “recipients”: [

                    { “group”: “b99f6d4f-243a-11e7-9742-005056b0187a” },

                    { “contact”: “0b7bf29a-2439-11e7-9742-005056b0187a” },

                    { “msisdn”: “+31765727000” }

                  ],

    “senders”: [“TEST”]

}’

 

 


 

2 – How to send message with more advanced settings/より高度なメッセージ配信

 

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages

POST/messages/v1/accounts/{accountId}/messages


Example post body:

{

    “body”: “Hello {{1}}, this is an advanced test message. This can contain a link => [[http://www.cm.com]] or CM Pages [[page:b99f6d4f-243a-11e7-9742-005056b0187a]] or OptOut instructions [[optout]]”,

    “ignoreUnsubscribes” : false,

    “scheduledAtUtc”: “2018-08-15T13:09:43.715Z”,

    “recipients”: [

                    { “group”: “b99f6d4f-243a-11e7-9742-005056b0187a” },

                    { “contact”: “0b7bf29a-2439-11e7-9742-005056b0187a” },

                    { “msisdn”: “+31627142592”, “data”: { “1”: “John”, “3”: “Doe”, “5”:”john.doe@cm.nl”,”6″: “CM.com” } }

                  ],

    “senders”: [“TEST”],

    “countrySpecificSenders”: {

        “NL”: “CM.com”,

        “BE”: “0032496448785”,

        “UK”: “88882”

    },

    “spread”: {

        “timeFrames”: [

            {

                “days”: [

                    “Mon”,

                    “Tue”,

                    “Wed”,

                    “Thu”,

                    “Fri”,

                    “Sat”,

                    “Sun”

                ],

                “startTime”: “09:00”,

                “endTime”: “12:00”

            },

            {

                “days”: [

                    “Mon”,

                    “Tue”,

                    “Wed”,

                    “Thu”,

                    “Fri”,

                    “Sat”,

                    “Sun”

                ],

                “startTime”: “13:00”,

                “endTime”: “17:30”

            }

        ],

        “until” : “2019-03-14T15:00:26.9932482Z”

    }

}

 

scheduledAtUtc : defines when the message will be sent, timezone is UTC, please make sure you adjust your time before supplying values.

Data tags like {{1}} are placeholders for custom data retrieved from Addressbook or msisdn data.

Links enclosed in double square brackets like [[http://www.cm.com]] will be converted into shortlinks like http://cm.to/sH012tL which are 21 characters long.

 Links must start with http:// or https://

CM Pages tags are enclosed in double square brackets, starts with page: and includes page the related page guid. They are also translated into shortlinks (21 chars).

Optout tag inserts optout instructions per recipient, if recipient’s country has a predefined shortcode for STOP messages it will translate into STOP shortcode otherwise it will translated into an optout link like http://NO-S.MS/OptOut

ignoreUnsubscribes : By default Messages API filters recipients using the Unsubscribes list in Addressbook. If this setting is set to true, unsubscribes will not be filtered.

Msisdn with data : It is possible to add a data dictionary to msisdn recipients so data tags in the body can be rendered also for msisdn recipients.

Senders : Specifies the default sender to use unless a specific sender is defined for recipients country in countrySpecificSenders setting

spread : Spread until setting makes sure that messages are delivered in batches over a certain amount of time between scheduled time and spread until setting. Value must be in UTC

timeFrames : Defines the allowed days and time periods where the messages are allowed to be sent.

 Time frame startTime and endTime values must be in UTC

scheduledAtUtc:メッセージが送信されるタイミングを定義します。タイムゾーンはUTCです。値を指定する前に必ず時間を調整してください。

{{1}}などのデータタグ、アドレス帳またはmsisdnデータから取得したカスタムデータのプレースホルダーです。

[[http://www.cm.com]]などの二重角括弧で囲まれたリンクは、21文字の長さのhttp://cm.to/sH012tLなどのショートリンクに変換されます。

リンクはhttp//またはhttps//で始まる必要があります

CM Pagesタグは二重角括弧で囲まれ、page:で始まり、関連ページguidのページが含まれます。また、ショートリンク(21文字)に変換されます。

オプトアウトタグは受信者ごとにオプトアウト手順を挿入します。受信者の国にSTOPメッセージの定義済みショートコードがある場合、STOPショートコードに変換されます。それ以外の場合は、http//NO-S.MS/OptOutのようなオプトアウトリンク

ignoreUnsubscribes:デフォルトでは、Messages APIはアドレス帳の登録解除リストを使用して受信者をフィルタリングします。この設定がtrueに設定されている場合、登録解除はフィルタリングされません。

Msisdn with data:データ辞書をmsisdn受信者に追加して、本文のデータタグをmsisdn受信者に対してもレンダリングできるようにすることが可能です。

SenderscountrySpecificSenders設定で受信者の国に特定の送信者が定義されていない限り、使用するデフォルトの送信者を指定します

spread:設定するまで拡散することにより、スケジュールされた時間と設定するまでの拡散との間の一定の時間にわたってメッセージが確実にバッチで配信されます。値はUTCでなければなりません

timeFrames:メッセージの送信が許可される許可されている日と期間を定義します。

 時間枠のstartTimeendTimeの値はUTCでなければなりません

 


 Below are the list of default data tags, if you have other custom fields defined in addressbook/msisdn data, you have to use relevant custom field ids.

以下はデフォルトのデータタグのリストです。アドレス帳/ msisdnデータで他のカスタムフィールドが定義されている場合は、関連するカスタムフィールドIDを使用する必要があります。

 

Name

FieldId

Tag

FirstName

1

1

Insertion

2

2

LastName

3

3

PhoneNumber

4

4

EmailAddress

5

5

Company

6

6

 

 

3 – Triggered (drip) Message Campaigns/トリガーメッセージ

Triggered messages aims to group similar messages sharing the same message template so that aggregated statistics for messages can be tracked without overflow in message history.

Triggered messages works in 2 steps, first a triggered message should be created, then triggered message is sent by adding recipients.

このトリガーメッセージとは同じメッセージテンプレートを共有するメッセージをグループ化することを目的としているため、メッセージの集計統計は、メッセージ履歴でオーバーフローすることなく追跡できます。

トリガーされたメッセージは2つのステップで機能します。最初にトリガーされたメッセージを作成し、次に受信者を追加してトリガーされたメッセージを送信します。

 

 

トリガーされたメッセージを作成するには以下をコールします

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages

Example request body is like follows;

{

    “body”: “Hi {{1}} this is a triggered message”,

    “channels”: [

        “SMS”

    ],

    “ignoreUnsubscribes”: true,

    “name”: “Trigger test”,

    “senders”: [

        “Trigger”

    ],

    “status”: “triggered”

}

 

You will get a response like follows

レスポンスは以下のようになります

{

    “id”: “67606cee-b8a9-4d28-988b-db6e73b21c81”, => this is the triggered campaign id to use when adding recipients

    “isStatsComplete”: false,

    “body”: “Hi {{1}} this is a triggered message”,

    “channels”: [

        “SMS”

    ],

    “ignoreUnsubscribes”: false,

    “name”: ” Trigger test “,

    “recipients”: [],

    “senders”: [

        “Trigger”

    ],

    “status”: “triggered”,

    “createdAtUtc”: “2019-10-15T07:27:04.3594636Z”,

    “createdBy”: “87067157-09e6-4a8e-b2da-06bfc126a8cd”,

    “updatedAtUtc”: “2019-10-15T07:27:02.0369763Z”

}

 

To add recipients we have to use our created campaigns trigger endpoint, we need to do a POST call to below endpoint with an array of recipients

https://api.cm.com/messages/v1/accounts/{accountId}/messages/{triggeredCampaignId}/trigger

Request should look like following

[

    {

        “msisdn”: “+31627142592”,

        “data”: {

            “1”: “John Doe”

        }

    }

]

 

You will get a HTTP 200 status with the number of added recipients

 

 

 

2,Channels/チャネル

Gets available channels.

GET https://api.cm.com/messages/v1/accounts/{accountId}/messagechannels

 

GET/messages/v1/accounts/{accountId}/messagechannels

 

     
     

Parameters/パラメーター

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Responses/レスポンス

HTTP Code

Description

Schema

200

OK

< < string, CM.Platform.Messages.Models.ApiChannelInfo > map > array

Example HTTP request

Request path

/messages/v1/accounts/string/messagechannels

Example HTTP response

Response 200

[ {

  “id” : “string”,

  “allowImages” : true,

  “name” : “string”,

  “whatsAppRequestId” : “00000000-0000-0000-0000-000000000000”,

  “type” : “string”

} ]

 

Channel id is to be used in the channels array in message request.

3,Messages/メッセージ

Adds a Message.

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages

 

POST/messages/v1/accounts/{accountId}/messages

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Body parameter

The Message.

Name : message

Flags : required

Type : CM.Platform.Messages.Models.ApiMessageRequest

Responses

HTTP Code

Description

Schema

201

Created

CM.Platform.Messages.Models.ApiMessageResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages

 

Request body

{

  “body” : “test”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “NL” : “CM.com”

  },

  “ignoreUnsubscribes” : false,

  “name” : “My Test Message”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “1” : “Data is only allowed when using msisdn”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “+3163710000”

  } ],

  “recurrence” : “not yet implemented”,

  “scheduledAtUtc” : “2019-01-11T13:15”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “CM.com” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “currently not available” ],

      “startTime” : “currently not available”,

      “endTime” : “currently not available”

    } ],

    “until” : “2019-01-12T13:15”

  }

}

Example HTTP response

Response 201

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : false,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

}

 

Gets Messages paged.

GET https://api.cm.com/messages/v1/accounts/{accountId}/messages

GET/messages/v1/accounts/{accountId}/messagechannels

 

Parameters

Type

Name

Description

Schema

Path

accountId

required

The account id.

アカウントID。

string (uuid)

Query

orderby

optional

Column names (date, price, recipients, name) to order messages. add desc to order descending (ex: date desc)

メッセージを注文するための列名(日付、価格、受信者、名前)。 降順で降順を追加(例:日付降順)

< string > array(multi)

Query

skip

optional

The skip.

スキップ。

integer (int32)

Query

status

optional

Message status id.

メッセージステータスID。

string

Query

take

optional

The take.

integer (int32)

Responses

HTTP Code

Description

Schema

200

OK

< CM.Platform.Messages.Models.ApiMessageResponse > array

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages

 

Example HTTP response

Response 200

[ {

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “tariff” : 0,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

} ]

Deletes multiple Messages.

DELETE https://api.cm.com/messages/v1/accounts/{accountId}/messages

DELETE/messages/v1/accounts/{accountId}/messages

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Query

messageIds

optional

The identifier.

< string (uuid) > array(multi)

Responses

HTTP Code

Description

Schema

204

NoContent

No Content

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages

 

Search messages with specified terms.

GET https://api.cm.com/messages/v1/accounts/{accountId}/messages/search/{term}

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

term

required

The search terms

string

Query

skip

optional

The skip.

integer (int32)

Query

take

optional

The take.

integer (int32)

 

Responses

HTTP Code

Description

Schema

200

OK

< CM.Platform.Messages.Models.ApiMessageResponse > array

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/search/searchterm

Example HTTP response

Response 200

[ {

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

} ]

Gets a Message by id.

GET https://api.cm.com/messages/v1/accounts/{accountId}/messages/{messageI

GET/messages/v1/accounts/{accountId}/messages/{messageId}

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

messageId

required

The identifier.

string (uuid)

Responses

HTTP Code

Description

Schema

200

OK

CM.Platform.Messages.Models.ApiMessageResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/00000000-0000-0000-0000-000000000000

 

Example HTTP response

Response 200

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

}

Updates a Message.

PUT https://api.cm.com/messages/v1/accounts/{accountId}/messages/{messageId}

PUT/messages/v1/accounts/{accountId}/messages/{messageId}


Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

messageId

required

The identifier.

string (uuid)

Body parameter

The Message.

Name : message

Flags : required

Type : CM.Platform.Messages.Models.ApiMessageRequest

Responses

HTTP Code

Description

Schema

200

OK

CM.Platform.Messages.Models.ApiMessageResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/00000000-0000-0000-0000-000000000000

Request body

{

  “body” : “string”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”

}

Example HTTP response

Response 200

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

}

Deletes a Message.

DELETE https://api.cm.com/messages/v1/accounts/{accountId}/messages/{messageId}

DELETE/messages/v1/accounts/{accountId}/messages/{messageId}


Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

messageId

required

The identifier.

string (uuid)

Responses

HTTP Code

Description

Schema

204

NoContent

No Content

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/00000000-0000-0000-0000-000000000000

Cancels a message, prevents the delivery of the remaining messages.

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages/{messageId}/cancel

POST/messages/v1/accounts/{accountId}/messages/{messageId}/cancel

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

messageId

required

The identifier.

string (uuid)

Responses

HTTP Code

Description

Schema

200

OK

CM.Platform.Messages.Models.ApiMessageResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/00000000-0000-0000-0000-000000000000/cancel

Example HTTP response

Response 200

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” : [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

}

Gets cost estimation for specified message

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages/cost

POST/messages/v1/accounts/{accountId}/messages/cost

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

messageId

required

The group ids to fetch

string (uuid)

Responses

HTTP Code

Description

Schema

200

OK

CM.Platform.Messages.Models.ApiMessageCost

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/cost

Request body

{

  “isArchived” : true,

  “body” : “string”,

  “channels” : [ “string” ],

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “grouping” : “string”,

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “content” : [ {

    “media” : {

      “mediaName” : “string”,

      “mediaUri” : “string”,

      “mimeType” : “string”

    },

    “whatsAppTemplate” : {

      “templateId” : “00000000-0000-0000-0000-000000000000”,

      “languageCode” : “string”,

      “languageFixed” : true,

      “parameters” : [ {

        “text” : “string”,

        “currency” : “string”,

        “currencyAmount” : “string”,

        “currencyCode” : “string”,

        “currencyDecimalSeparator” : “string”,

        “dateTime” : “string”,

        “dateOptions” : {

          “showDayOfWeek” : true,

          “showYear” : true,

          “showMonth” : true,

          “showDayOfMonth” : true,

          “showHour” : true,

          “showMinute” : true

        }

      } ]

    },

    “text” : “string”

  } ],

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “durationMinutes” : 0,

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “updatedAtUtc” : “string”

}

Example HTTP response

Response 200

{

  “charsLeft” : 0,

  “charsToRemove” : 0,

  “countryCosts” : [ {

    “cost” : 0.0,

    “countryCode” : “string”,

    “isMultipart” : true,

    “messageCount” : 0,

    “recipientCount” : 0

  } ],

  “currency” : “string”,

  “isMultipart” : true,

  “messageCount” : 0,

  “minDeliveryTime” : 0,

  “recipientCount” : 0,

  “totalCost” : 0.0

}

Pause sending a message.

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages/{messageId}/pause
POST/messages/v1/accounts/{accountId}/messages/{messageId}/paus

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

messageId

required

The identifier.

string (uuid)

Responses

HTTP Code

Description

Schema

200

OK

CM.Platform.Messages.Models.ApiMessageResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/00000000-0000-0000-0000-000000000000/pause

Example HTTP response

Response 200

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” :  [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

 

}

Resume sending a message.

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages/{messageId}/resume

POST/messages/v1/accounts/{accountId}/messages/{messageId}/resume



Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

messageId

required

The identifier.

string (uuid)

Responses

HTTP Code

Description

Schema

200

OK

CM.Platform.Messages.Models.ApiMessageResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/00000000-0000-0000-0000-000000000000/resume

Example HTTP response

Response 200

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “delivered” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “optedOut” : 0,

    “recipients” : 0,

    “test” : 0

  },

  “body” : “string”,

  “channels” :  [“SMS”] ,

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”

}

Sends a test message.

POST https://api.cm.com/messages/v1/accounts/{accountId}/messages//test
POST

 

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Body parameter

The Message.

Name : testMessage

Flags : required

Type : CM.Platform.Messages.Models.ApiTestMessageRequest

Responses

HTTP Code

Description

Schema

201

Created

CM.Platform.Messages.Models.ApiMessageResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/messages/test

Request body

{

  “message” : {

    “isArchived” : true,

    “body” : “string”,

    “channels” : [ “string” ],

    “countrySpecificSenders” : {

      “string” : “string”

    },

    “grouping” : “string”,

    “ignoreUnsubscribes” : true,

    “name” : “string”,

    “recipients” : [ {

      “contact” : “00000000-0000-0000-0000-000000000000”,

      “data” : {

        “string” : “string”

      },

      “group” : “00000000-0000-0000-0000-000000000000”,

      “msisdn” : “string”

    } ],

    “recurrence” : “string”,

    “content” : [ {

      “media” : {

        “mediaName” : “string”,

        “mediaUri” : “string”,

        “mimeType” : “string”

      },

      “whatsAppTemplate” : {

        “templateId” : “00000000-0000-0000-0000-000000000000”,

        “languageCode” : “string”,

        “languageFixed” : true,

        “parameters” : [ {

          “text” : “string”,

          “currency” : “string”,

          “currencyAmount” : “string”,

          “currencyCode” : “string”,

          “currencyDecimalSeparator” : “string”,

          “dateTime” : “string”,

          “dateOptions” : {

            “showDayOfWeek” : true,

            “showYear” : true,

            “showMonth” : true,

            “showDayOfMonth” : true,

            “showHour” : true,

            “showMinute” : true

          }

        } ]

      },

      “text” : “string”

    } ],

    “scheduledAtUtc” : “string”,

    “senderPreset” : “00000000-0000-0000-0000-000000000000”,

    “senders” : [ “string” ],

    “spread” : {

      “durationMinutes” : 0,

      “timeFrames” : [ {

        “days” : [ “string” ],

        “startTime” : “string”,

        “endTime” : “string”

      } ],

      “until” : “string”

    },

    “status” : “string”,

    “updatedAtUtc” : “string”

  },

  “testRecipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ]

}

Example HTTP response

Response 201

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “isStatsComplete” : true,

  “isArchived” : true,

  “analytics” : {

    “accepted” : 0,

    “converted” : 0,

    “countryErrorStats” : [ {

      “country” : “string”,

      “count” : 0,

      “errorCode” : 0

    } ],

    “countryStats” : [ {

      “country” : “string”,

      “accepted” : 0,

      “converted” : 0,

      “delivered” : 0,

      “deliveryTime” : 0.0,

      “dispatched” : 0,

      “failed” : 0,

      “messages” : 0,

      “optedOut” : 0,

      “optOutReceived” : 0,

      “recipients” : 0

    } ],

    “deduplicated” : 0,

    “delivered” : 0,

    “deliveryTime” : 0.0,

    “dispatched” : 0,

    “euroPrice” : 0.0,

    “failed” : 0,

    “localCurrency” : “string”,

    “localPrice” : 0.0,

    “messages” : 0,

    “optedOut” : 0,

    “optOutReceived” : 0,

    “recipients” : 0,

    “test” : 0,

    “updatedAtUtc” : “string”

  },

  “preview” : {

    “previews” : [ “string” ],

    “previewCode” : “string”,

    “sender” : “string”,

    “recipientsPerCountry” : [ {

      “count” : 0,

      “countryCode” : “string”

    } ],

    “languages” : [ “string” ]

  },

  “body” : “string”,

  “channels” : [ “string” ],

  “countrySpecificSenders” : {

    “string” : “string”

  },

  “grouping” : “string”,

  “ignoreUnsubscribes” : true,

  “name” : “string”,

  “recipients” : [ {

    “contact” : “00000000-0000-0000-0000-000000000000”,

    “data” : {

      “string” : “string”

    },

    “group” : “00000000-0000-0000-0000-000000000000”,

    “msisdn” : “string”

  } ],

  “recurrence” : “string”,

  “content” : [ {

    “media” : {

      “mediaName” : “string”,

      “mediaUri” : “string”,

      “mimeType” : “string”

    },

    “whatsAppTemplate” : {

      “templateId” : “00000000-0000-0000-0000-000000000000”,

      “languageCode” : “string”,

      “languageFixed” : true,

      “parameters” : [ {

        “text” : “string”,

        “currency” : “string”,

        “currencyAmount” : “string”,

        “currencyCode” : “string”,

        “currencyDecimalSeparator” : “string”,

        “dateTime” : “string”,

        “dateOptions” : {

          “showDayOfWeek” : true,

          “showYear” : true,

          “showMonth” : true,

          “showDayOfMonth” : true,

          “showHour” : true,

          “showMinute” : true

        }

      } ]

    },

    “text” : “string”

  } ],

  “scheduledAtUtc” : “string”,

  “senderPreset” : “00000000-0000-0000-0000-000000000000”,

  “senders” : [ “string” ],

  “spread” : {

    “durationMinutes” : 0,

    “timeFrames” : [ {

      “days” : [ “string” ],

      “startTime” : “string”,

      “endTime” : “string”

    } ],

    “until” : “string”

  },

  “status” : “string”,

  “createdAtUtc” : “string”,

  “createdBy” : “00000000-0000-0000-0000-000000000000”,

  “updatedAtUtc” : “string”

}

Senders

Adds a Sender.

POST https://api.cm.com/messages/v1/accounts/{accountId}/senders

 

POST/messages/v1/accounts/{accountId}/senders

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Body parameter

The sender.

Name : sender

Flags : required

Type : CM.Platform.Messages.Models.ApiSenderPresetRequest

Responses

HTTP Code

Description

Schema

201

Created

CM.Platform.Messages.Models.ApiSenderPresetResponse

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/senders

Request body

{

  “isFavorite” : true,

  “name” : “string”,

  “senders” : {

    “string” : “string”

  }

}

Example HTTP response

Response 201

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “isFavorite” : true,

  “name” : “string”,

  “senders” : {

    “string” : “string”

  }

}

Gets senders.

GET https://api.cm.com/messages/v1/accounts/{accountId}/senders

GET/messages/v1/accounts/{accountId}/senders

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Responses

HTTP Code

Description

Schema

200

OK

< CM.Platform.Messages.Models.ApiSenderPresetResponse > array

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/string/senders

Example HTTP response

Response 200

[ {

  “id” : “00000000-0000-0000-0000-000000000000”,

  “isFavorite” : true,

  “name” : “string”,

  “senders” : {

    “string” : “string”

  }

} ]

Updates a Sender.

PUT https://api.cm.com/messages/v1/accounts/{accountId}/senders/{senderId}

PUT/messages/v1/accounts/{accountId}/senders/{senderId}

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

senderId

required

The identifier.

string (uuid)

Body parameter

The sender.

Name : senderPreset

Flags : required

Type : CM.Platform.Messages.Models.ApiSenderPresetRequest

Responses

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/senders/00000000-0000-0000-0000-000000000000

Request body

{

  “isFavorite” : true,

  “name” : “string”,

  “senders” : {

    “string” : “string”

  }

}

Example HTTP response

Response 200

{

  “id” : “00000000-0000-0000-0000-000000000000”,

  “isFavorite” : true,

  “name” : “string”,

  “senders” : {

    “string” : “string”

  }

}

Deletes a Sender.

DELETE https://api.cm.com/messages/v1/accounts/{accountId}/senders/{senderId}

DELETE/messages/v1/accounts/{accountId}/senders/{senderId}

 

Parameters

Type

Name

Description

Schema

Path

accountId

required

The accountId.

string (uuid)

Path

senderId

required

The identifier.

string (uuid)

Responses

HTTP Code

Description

Schema

204

NoContent

No Content

Example HTTP request

Request path

https://api.cm.com/messages/v1/accounts/00000000-0000-0000-0000-000000000000/senders/00000000-0000-0000-0000-000000000000

Definitions

定義

CM.Platform.Messages.Models.ApiChannelInfo

 

Name

Description

Schema

disabled

optional

Example : true

boolean

name

optional

Example : “string”

string

options

optional

Example : “[cm-platform-messages-models-apichanneloptions](#cm-platform-messages-models-apichanneloptions)”

CM.Platform.Messages.Models.ApiChannelOptions

type

optional

Example : “string”

string

CM.Platform.Messages.Models.ApiChannelOptions

Name

Description

Schema

allowImages

optional

Example : true

boolean

allowTemplates

optional

Example : true

boolean

appKey

optional

Example : “00000000-0000-0000-0000-000000000000”

string (uuid)

requestId

optional

Example : “00000000-0000-0000-0000-000000000000”

string (uuid)

CM.Platform.Messages.Models.ApiCountryCost

Container for the message cost per country
国ごとのメッセージコストのコンテナ

Name

Description

Schema

cost

optional

Gets or sets the cost of the messages for country.
国のメッセージのコストを取得または設定します。

Example : 0.0

number (double)

countryCode

optional

Gets or sets the country code.
国コードを取得または設定します。

Example : “string”

string

isMultipart

optional

Gets or sets if there are Multipart messages
マルチパートメッセージがあるかどうかを取得または設定します。

Example : true

boolean

messageCount

optional

Gets or sets the count of the messages for country.
国のメッセージの数を取得または設定します。

Example : 0

integer (int32)

recipientCount

optional

Gets or sets the count of the recipient for country.
国の受信者の数を取得または設定します。

Example : 0

integer (int32)

CM.Platform.Messages.Models.ApiCountryErrorStats

Name

Description

Schema

count

optional

Gets or sets the count.
回数を取得または設定します。

 

 

Example : 0

integer (int32)

country

optional

Gets or sets the country.
を取得または設定します。

Example : “string”

string

errorCode

optional

Gets or sets the errorCode.
errorCodeを取得または設定します。

Example : 0

integer (int32)

CM.Platform.Messages.Models.ApiCountryStats

Name

Description

Schema

accepted

optional

Gets or sets the accepted.
受け入れられたものを取得または設定します。

Example : 0

integer (int32)

converted

optional

Gets or sets the converted.
変換済みを取得または設定します。

Example : 0

integer (int32)

country

optional

Gets or sets the country.
国を取得または設定します

Example : “string”

string

delivered

optional

Gets or sets the delivered.
配信を取得または設定します。

Example : 0

integer (int32)

deliveryTime

optional

Gets or sets the deliveryTime.
deliveryTimeを取得または設定します。

Example : 0.0

number (double)

dispatched

optional

Gets or sets the dispatched.
dispatchedを取得または設定します。

 

Example : 0

integer (int32)

failed

optional

Gets or sets the failed.
失敗したものを取得または設定します。

Example : 0

integer (int32)

messages

optional

Gets or sets the messages.
メッセージを取得または設定します。

Example : 0

integer (int32)

optOutReceived

optional

Gets or sets the optOutReceived.
optOutReceivedを取得または設定します。

Example : 0

integer (int32)

optedOut

optional

Gets or sets the optedOut.
optedOutを取得または設定します。

Example : 0

integer (int32)

recipients

optional

Gets or sets the recipients.
受信者を取得または設定します。

Example : 0

integer (int32)

CM.Platform.Messages.Models.ApiMessageAnalytics

The message analytics model.
メッセージ分析モデル。

Name

Description

Schema

accepted

optional

Gets or sets the accepted.
受け入れられたものを取得または設定します。

Example : 0

integer (int32)

converted

optional

Gets or sets the converted.
変換済みを取得または設定します。

Example : 0

integer (int32)

countryErrorStats

optional

Gets or sets the countryErrorStats.
countryErrorStatsを取得または設定します。

Example : [ “[cm-platform-messages-models-apicountryerrorstats](#cm-platform-messages-models-apicountryerrorstats)” ]

< CM.Platform.Messages.Models.ApiCountryErrorStats > array

countryStats

optional

Gets or sets the countryStats.
countryStatsを取得または設定します。

 

 

Example : [ “[cm-platform-messages-models-apicountrystats](#cm-platform-messages-models-apicountrystats)” ]

< CM.Platform.Messages.Models.ApiCountryStats > array

deduplicated

optional

Gets or sets the deduplicated.
deduplicatedを取得または設定します。

Example : 0

integer (int32)

delivered

optional

Gets or sets the delivered.
配信を取得または設定します。

Example : 0

integer (int32)

deliveryTime

optional

Gets or sets the deliveryTime.
deliveryTimeを取得または設定します。

 

 

Example : 0.0

number (double)

dispatched

optional

Gets or sets the dispatched.
dispatchedを取得または設定します。

Example : 0

integer (int32)

euroPrice

optional

Gets or sets the euroPrice.
euroPriceを取得または設定します。

Example : 0.0

number (double)

failed

optional

Gets or sets the failed.
失敗したものを取得または設定します。

Example : 0

integer (int32)

localCurrency

optional

Gets or sets the localCurrency.
localCurrencyを取得または設定します。

Example : “string”

string

localPrice

optional

Gets or sets the localPrice.
localPriceを取得または設定します。

Example : 0.0

number (double)

messages

optional

Gets or sets the messages.
メッセージを取得または設定します。

Example : 0

integer (int32)

optOutReceived

optional

Gets or sets the optOutReceived.
optedOutReceivedを取得または設定します。

 

 

Example : 0

integer (int32)

optedOut

optional

Gets or sets the optedOut.
optedOutを取得または設定します。

Example : 0

integer (int32)

recipients

optional

Gets or sets the recipients.
受信者を取得または設定します。

Example : 0

integer (int32)

test

optional

Gets or sets test message count.
テストメッセージ数を取得または設定します。

Example : 0

integer (int32)

updatedAtUtc

optional

Gets or sets updated timestamp.
アップデートされたタイムスタンプを取得または設定します。

Example : “string”

string (date-time)

CM.Platform.Messages.Models.ApiMessageChannel

 

Name

Description

Schema

allowImages

optional

Example : true

boolean

id

optional

Example : “string”

string

name

optional

Example : “string”

string

type

optional

Example : “string”

string

whatsAppRequestId

optional

Example : “00000000-0000-0000-0000-000000000000”

string (uuid)

CM.Platform.Messages.Models.ApiMessageChannel

Name

Description

Schema

allowImages

optional

Example : true

boolean

id

optional

Example : “string”

string

name

optional

Example : “string”

string

type

optional

Example : “string”

string

whatsAppRequestId

optional

Example : “00000000-0000-0000-0000-000000000000”

string (uuid)

CM.Platform.Messages.Models.ApiMessageCost

Container for the Message cost.
メッセージコストのコンテナ

Name

Description

Schema

charsLeft

optional

Gets or sets the min chars left for 1 more part
残りのパートのために最小文字数を取得または設定します。

Example : 0

integer (int32)

charsToRemove

optional

Gets or sets the min chars to remove for 1 less part
1つ少ないパートのために削除する最小文字数を取得または設定します。

Example : 0

integer (int32)

countryCosts

optional

Gets or sets the count and cost of the messages per country.
国ごとのメッセージの数とコストを取得または設定します。

Example : [ “[cm-platform-messages-models-apicountrycost](#cm-platform-messages-models-apicountrycost)” ]

< CM.Platform.Messages.Models.ApiCountryCost > array

currency

optional

Gets or sets the currency.
通貨を取得または設定します。

Example : “string”