/vendor/sendinblue/api-v3-sdk/docs/Api/TransactionalSMSApi.md

https://gitlab.com/i-have-a-green/digitemis-v3 · Markdown · 266 lines · 202 code · 64 blank · 0 comment · 0 complexity · f21c24b97653e94e959dcca9dd074116 MD5 · raw file 

    

  1. # SendinBlue\Client\TransactionalSMSApi
    2. 

  2. 

  3. All URIs are relative to *https://api.sendinblue.com/v3*
    4. 

  4. 

  5. Method | HTTP request | Description
    6. 

  6. ------------- | ------------- | -------------
    7. 

  7. [**getSmsEvents**](TransactionalSMSApi.md#getSmsEvents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
    8. 

  8. [**getTransacAggregatedSmsReport**](TransactionalSMSApi.md#getTransacAggregatedSmsReport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
    9. 

  9. [**getTransacSmsReport**](TransactionalSMSApi.md#getTransacSmsReport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
    10. 

  10. [**sendTransacSms**](TransactionalSMSApi.md#sendTransacSms) | **POST** /transactionalSMS/sms | Send the SMS campaign to a mobile number
    11. 

  11. 

  12. 

  13. # **getSmsEvents**
    14. 

  14. > \SendinBlue\Client\Model\GetSmsEventReport getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags)
    15. 

  15. 

  16. Get all your SMS activity (unaggregated events)
    17. 

  17. 

  18. ### Example
    19. 

  19. ```php
    20. 

  20. <?php
    21. 

  21. require_once(__DIR__ . '/vendor/autoload.php');
    22. 

    23. 

  23. // Configure API key authorization: api-key
    24. 

  24. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
    25. 

  25. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    26. 

  26. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
    27. 

  27. // Configure API key authorization: partner-key
    28. 

  28. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
    29. 

  29. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    30. 

  30. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
    31. 

    32. 

  32. $apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
    33. 

  33.     // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    34. 

  34.     // This is optional, `GuzzleHttp\Client` will be used as default.
    35. 

  35.     new GuzzleHttp\Client(),
    36. 

  36.     $config
    37. 

  37. );
    38. 

  38. $limit = 50; // int | Number of documents per page
    39. 

  39. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
    40. 

  40. $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
    41. 

  41. $offset = 0; // int | Index of the first document of the page
    42. 

  42. $days = 56; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
    43. 

  43. $phoneNumber = "phoneNumber_example"; // string | Filter the report for a specific phone number
    44. 

  44. $event = "event_example"; // string | Filter the report for specific events
    45. 

  45. $tags = "tags_example"; // string | Filter the report for specific tags passed as a serialized urlencoded array
    46. 

    47. 

  47. try {
    48. 

  48.     $result = $apiInstance->getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags);
    49. 

  49.     print_r($result);
    50. 

  50. } catch (Exception $e) {
    51. 

  51.     echo 'Exception when calling TransactionalSMSApi->getSmsEvents: ', $e->getMessage(), PHP_EOL;
    52. 

  52. }
    53. 

  53. ?>
    54. 

  54. ```
    55. 

  55. 

  56. ### Parameters
    57. 

  57. 

  58. Name | Type | Description  | Notes
    59. 

  59. ------------- | ------------- | ------------- | -------------
    60. 

  60.  **limit** | **int**| Number of documents per page | [optional] [default to 50]
    61. 

  61.  **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
    62. 

  62.  **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
    63. 

  63.  **offset** | **int**| Index of the first document of the page | [optional] [default to 0]
    64. 

  64.  **days** | **int**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
    65. 

  65.  **phoneNumber** | **string**| Filter the report for a specific phone number | [optional]
    66. 

  66.  **event** | **string**| Filter the report for specific events | [optional]
    67. 

  67.  **tags** | **string**| Filter the report for specific tags passed as a serialized urlencoded array | [optional]
    68. 

  68. 

  69. ### Return type
    70. 

  70. 

  71. [**\SendinBlue\Client\Model\GetSmsEventReport**](../Model/GetSmsEventReport.md)
    72. 

  72. 

  73. ### Authorization
    74. 

  74. 

  75. [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
    76. 

  76. 

  77. ### HTTP request headers
    78. 

  78. 

  79.  - **Content-Type**: application/json
    80. 

  80.  - **Accept**: application/json
    81. 

  81. 

  82. [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
    83. 

  83. 

  84. # **getTransacAggregatedSmsReport**
    85. 

  85. > \SendinBlue\Client\Model\GetTransacAggregatedSmsReport getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag)
    86. 

  86. 

  87. Get your SMS activity aggregated over a period of time
    88. 

  88. 

  89. ### Example
    90. 

  90. ```php
    91. 

  91. <?php
    92. 

  92. require_once(__DIR__ . '/vendor/autoload.php');
    93. 

    94. 

  94. // Configure API key authorization: api-key
    95. 

  95. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
    96. 

  96. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    97. 

  97. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
    98. 

  98. // Configure API key authorization: partner-key
    99. 

  99. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
    100. 

  100. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    101. 

  101. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
    102. 

    103. 

  103. $apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
    104. 

  104.     // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    105. 

  105.     // This is optional, `GuzzleHttp\Client` will be used as default.
    106. 

  106.     new GuzzleHttp\Client(),
    107. 

  107.     $config
    108. 

  108. );
    109. 

  109. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
    110. 

  110. $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
    111. 

  111. $days = 56; // int | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
    112. 

  112. $tag = "tag_example"; // string | Filter on a tag
    113. 

    114. 

  114. try {
    115. 

  115.     $result = $apiInstance->getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag);
    116. 

  116.     print_r($result);
    117. 

  117. } catch (Exception $e) {
    118. 

  118.     echo 'Exception when calling TransactionalSMSApi->getTransacAggregatedSmsReport: ', $e->getMessage(), PHP_EOL;
    119. 

  119. }
    120. 

  120. ?>
    121. 

  121. ```
    122. 

  122. 

  123. ### Parameters
    124. 

  124. 

  125. Name | Type | Description  | Notes
    126. 

  126. ------------- | ------------- | ------------- | -------------
    127. 

  127.  **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
    128. 

  128.  **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
    129. 

  129.  **days** | **int**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional]
    130. 

  130.  **tag** | **string**| Filter on a tag | [optional]
    131. 

  131. 

  132. ### Return type
    133. 

  133. 

  134. [**\SendinBlue\Client\Model\GetTransacAggregatedSmsReport**](../Model/GetTransacAggregatedSmsReport.md)
    135. 

  135. 

  136. ### Authorization
    137. 

  137. 

  138. [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
    139. 

  139. 

  140. ### HTTP request headers
    141. 

  141. 

  142.  - **Content-Type**: application/json
    143. 

  143.  - **Accept**: application/json
    144. 

  144. 

  145. [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
    146. 

  146. 

  147. # **getTransacSmsReport**
    148. 

  148. > \SendinBlue\Client\Model\GetTransacSmsReport getTransacSmsReport($startDate, $endDate, $days, $tag)
    149. 

  149. 

  150. Get your SMS activity aggregated per day
    151. 

  151. 

  152. ### Example
    153. 

  153. ```php
    154. 

  154. <?php
    155. 

  155. require_once(__DIR__ . '/vendor/autoload.php');
    156. 

    157. 

  157. // Configure API key authorization: api-key
    158. 

  158. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
    159. 

  159. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    160. 

  160. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
    161. 

  161. // Configure API key authorization: partner-key
    162. 

  162. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
    163. 

  163. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    164. 

  164. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
    165. 

    166. 

  166. $apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
    167. 

  167.     // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    168. 

  168.     // This is optional, `GuzzleHttp\Client` will be used as default.
    169. 

  169.     new GuzzleHttp\Client(),
    170. 

  170.     $config
    171. 

  171. );
    172. 

  172. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
    173. 

  173. $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
    174. 

  174. $days = 56; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
    175. 

  175. $tag = "tag_example"; // string | Filter on a tag
    176. 

    177. 

  177. try {
    178. 

  178.     $result = $apiInstance->getTransacSmsReport($startDate, $endDate, $days, $tag);
    179. 

  179.     print_r($result);
    180. 

  180. } catch (Exception $e) {
    181. 

  181.     echo 'Exception when calling TransactionalSMSApi->getTransacSmsReport: ', $e->getMessage(), PHP_EOL;
    182. 

  182. }
    183. 

  183. ?>
    184. 

  184. ```
    185. 

  185. 

  186. ### Parameters
    187. 

  187. 

  188. Name | Type | Description  | Notes
    189. 

  189. ------------- | ------------- | ------------- | -------------
    190. 

  190.  **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
    191. 

  191.  **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
    192. 

  192.  **days** | **int**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
    193. 

  193.  **tag** | **string**| Filter on a tag | [optional]
    194. 

  194. 

  195. ### Return type
    196. 

  196. 

  197. [**\SendinBlue\Client\Model\GetTransacSmsReport**](../Model/GetTransacSmsReport.md)
    198. 

  198. 

  199. ### Authorization
    200. 

  200. 

  201. [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
    202. 

  202. 

  203. ### HTTP request headers
    204. 

  204. 

  205.  - **Content-Type**: application/json
    206. 

  206.  - **Accept**: application/json
    207. 

  207. 

  208. [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
    209. 

  209. 

  210. # **sendTransacSms**
    211. 

  211. > \SendinBlue\Client\Model\SendSms sendTransacSms($sendTransacSms)
    212. 

  212. 

  213. Send the SMS campaign to a mobile number
    214. 

  214. 

  215. ### Example
    216. 

  216. ```php
    217. 

  217. <?php
    218. 

  218. require_once(__DIR__ . '/vendor/autoload.php');
    219. 

    220. 

  220. // Configure API key authorization: api-key
    221. 

  221. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
    222. 

  222. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    223. 

  223. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
    224. 

  224. // Configure API key authorization: partner-key
    225. 

  225. $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
    226. 

  226. // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    227. 

  227. // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
    228. 

    229. 

  229. $apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
    230. 

  230.     // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    231. 

  231.     // This is optional, `GuzzleHttp\Client` will be used as default.
    232. 

  232.     new GuzzleHttp\Client(),
    233. 

  233.     $config
    234. 

  234. );
    235. 

  235. $sendTransacSms = new \SendinBlue\Client\Model\SendTransacSms(); // \SendinBlue\Client\Model\SendTransacSms | Values to send a transactional SMS
    236. 

    237. 

  237. try {
    238. 

  238.     $result = $apiInstance->sendTransacSms($sendTransacSms);
    239. 

  239.     print_r($result);
    240. 

  240. } catch (Exception $e) {
    241. 

  241.     echo 'Exception when calling TransactionalSMSApi->sendTransacSms: ', $e->getMessage(), PHP_EOL;
    242. 

  242. }
    243. 

  243. ?>
    244. 

  244. ```
    245. 

  245. 

  246. ### Parameters
    247. 

  247. 

  248. Name | Type | Description  | Notes
    249. 

  249. ------------- | ------------- | ------------- | -------------
    250. 

  250.  **sendTransacSms** | [**\SendinBlue\Client\Model\SendTransacSms**](../Model/SendTransacSms.md)| Values to send a transactional SMS |
    251. 

  251. 

  252. ### Return type
    253. 

  253. 

  254. [**\SendinBlue\Client\Model\SendSms**](../Model/SendSms.md)
    255. 

  255. 

  256. ### Authorization
    257. 

  257. 

  258. [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
    259. 

  259. 

  260. ### HTTP request headers
    261. 

  261. 

  262.  - **Content-Type**: application/json
    263. 

  263.  - **Accept**: application/json
    264. 

  264. 

  265. [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
    266.