All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| GetSmsEvents | Get /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) |
| GetTransacAggregatedSmsReport | Get /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time |
| GetTransacSmsReport | Get /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day |
| SendTransacSms | Post /transactionalSMS/sms | Send SMS message to a mobile number |
GetSmsEventReport GetSmsEvents(ctx, optional) Get all your SMS activity (unaggregated events)
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetSmsEventsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetSmsEventsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int64 | Number of documents per page | [default to 50] |
| startDate | optional.String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | |
| endDate | optional.String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | |
| offset | optional.Int64 | Index of the first document of the page | [default to 0] |
| days | optional.Int64 | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | |
| phoneNumber | optional.String | Filter the report for a specific phone number | |
| event | optional.String | Filter the report for specific events | |
| tags | optional.String | Filter the report for specific tags passed as a serialized urlencoded array | |
| sort | optional.String | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [default to desc] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTransacAggregatedSmsReport GetTransacAggregatedSmsReport(ctx, optional) Get your SMS activity aggregated over a period of time
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetTransacAggregatedSmsReportOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetTransacAggregatedSmsReportOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| startDate | optional.String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | |
| endDate | optional.String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | |
| days | optional.Int64 | Number of days in the past including today (positive integer). Not compatible with startDate and endDate | |
| tag | optional.String | Filter on a tag |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTransacSmsReport GetTransacSmsReport(ctx, optional) Get your SMS activity aggregated per day
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetTransacSmsReportOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetTransacSmsReportOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| startDate | optional.String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | |
| endDate | optional.String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | |
| days | optional.Int64 | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | |
| tag | optional.String | Filter on a tag | |
| sort | optional.String | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [default to desc] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SendSms SendTransacSms(ctx, sendTransacSms) Send SMS message to a mobile number
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| sendTransacSms | SendTransacSms | Values to send a transactional SMS |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]