Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 | 12x 12x 12x 12x 4x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 12x 4x 4x 2x 2x 2x 2x 2x 2x 2x 2x 12x 12x 12x 2x 12x 2x 12x | /* tslint:disable */
/* eslint-disable */
/**
* Bandwidth
* Bandwidth\'s Communication APIs
*
* The version of the OpenAPI document: 1.0.0
* Contact: letstalk@bandwidth.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import type { CreateMessageRequestError } from '../models';
// @ts-ignore
import type { ListMessageDirectionEnum } from '../models';
// @ts-ignore
import type { Message } from '../models';
// @ts-ignore
import type { MessageRequest } from '../models';
// @ts-ignore
import type { MessageStatusEnum } from '../models';
// @ts-ignore
import type { MessageTypeEnum } from '../models';
// @ts-ignore
import type { MessagesList } from '../models';
// @ts-ignore
import type { MessagingRequestError } from '../models';
// @ts-ignore
import type { ProductTypeEnum } from '../models';
/**
* MessagesApi - axios parameter creator
*/
export const MessagesApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Endpoint for sending text messages and picture messages using V2 messaging.
* @summary Create Message
* @param {string} accountId Your Bandwidth Account ID.
* @param {MessageRequest} messageRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createMessage: async (accountId: string, messageRequest: MessageRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('createMessage', 'accountId', accountId)
// verify required parameter 'messageRequest' is not null or undefined
assertParamExists('createMessage', 'messageRequest', messageRequest)
const localVarPath = `/users/{accountId}/messages`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Basic required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication OAuth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(messageRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
* @param {number} [errorCode] The error code of the message.
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [campaignId] The campaign ID of the message.
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
* @param {string} [location] Location Id associated with the message.
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
* @param {number} [fromSegmentCount] Segment count (start range).
* @param {number} [toSegmentCount] Segment count (end range).
* @param {number} [fromMessageSize] Message size (start range).
* @param {number} [toMessageSize] Message size (end range).
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listMessages: async (accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('listMessages', 'accountId', accountId)
const localVarPath = `/users/{accountId}/messages`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Basic required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication OAuth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
Iif (messageId !== undefined) {
localVarQueryParameter['messageId'] = messageId;
}
Iif (sourceTn !== undefined) {
localVarQueryParameter['sourceTn'] = sourceTn;
}
Iif (destinationTn !== undefined) {
localVarQueryParameter['destinationTn'] = destinationTn;
}
Iif (messageStatus !== undefined) {
localVarQueryParameter['messageStatus'] = messageStatus;
}
Iif (messageDirection !== undefined) {
localVarQueryParameter['messageDirection'] = messageDirection;
}
Iif (carrierName !== undefined) {
localVarQueryParameter['carrierName'] = carrierName;
}
Iif (messageType !== undefined) {
localVarQueryParameter['messageType'] = messageType;
}
Iif (errorCode !== undefined) {
localVarQueryParameter['errorCode'] = errorCode;
}
Iif (fromDateTime !== undefined) {
localVarQueryParameter['fromDateTime'] = fromDateTime;
}
Iif (toDateTime !== undefined) {
localVarQueryParameter['toDateTime'] = toDateTime;
}
Iif (campaignId !== undefined) {
localVarQueryParameter['campaignId'] = campaignId;
}
Iif (fromBwLatency !== undefined) {
localVarQueryParameter['fromBwLatency'] = fromBwLatency;
}
Iif (bwQueued !== undefined) {
localVarQueryParameter['bwQueued'] = bwQueued;
}
Iif (product !== undefined) {
localVarQueryParameter['product'] = product;
}
Iif (location !== undefined) {
localVarQueryParameter['location'] = location;
}
Iif (carrierQueued !== undefined) {
localVarQueryParameter['carrierQueued'] = carrierQueued;
}
Iif (fromCarrierLatency !== undefined) {
localVarQueryParameter['fromCarrierLatency'] = fromCarrierLatency;
}
Iif (callingNumberCountryA3 !== undefined) {
localVarQueryParameter['callingNumberCountryA3'] = callingNumberCountryA3;
}
Iif (calledNumberCountryA3 !== undefined) {
localVarQueryParameter['calledNumberCountryA3'] = calledNumberCountryA3;
}
Iif (fromSegmentCount !== undefined) {
localVarQueryParameter['fromSegmentCount'] = fromSegmentCount;
}
Iif (toSegmentCount !== undefined) {
localVarQueryParameter['toSegmentCount'] = toSegmentCount;
}
Iif (fromMessageSize !== undefined) {
localVarQueryParameter['fromMessageSize'] = fromMessageSize;
}
Iif (toMessageSize !== undefined) {
localVarQueryParameter['toMessageSize'] = toMessageSize;
}
Iif (sort !== undefined) {
localVarQueryParameter['sort'] = sort;
}
Iif (pageToken !== undefined) {
localVarQueryParameter['pageToken'] = pageToken;
}
Iif (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
Iif (limitTotalCount !== undefined) {
localVarQueryParameter['limitTotalCount'] = limitTotalCount;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* MessagesApi - functional programming interface
*/
export const MessagesApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = MessagesApiAxiosParamCreator(configuration)
return {
/**
* Endpoint for sending text messages and picture messages using V2 messaging.
* @summary Create Message
* @param {string} accountId Your Bandwidth Account ID.
* @param {MessageRequest} messageRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createMessage(accountId: string, messageRequest: MessageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Message>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.createMessage(accountId, messageRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['MessagesApi.createMessage']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
* @param {number} [errorCode] The error code of the message.
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [campaignId] The campaign ID of the message.
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
* @param {string} [location] Location Id associated with the message.
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
* @param {number} [fromSegmentCount] Segment count (start range).
* @param {number} [toSegmentCount] Segment count (end range).
* @param {number} [fromMessageSize] Message size (start range).
* @param {number} [toMessageSize] Message size (end range).
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagesList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, fromBwLatency, bwQueued, product, location, carrierQueued, fromCarrierLatency, callingNumberCountryA3, calledNumberCountryA3, fromSegmentCount, toSegmentCount, fromMessageSize, toMessageSize, sort, pageToken, limit, limitTotalCount, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['MessagesApi.listMessages']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* MessagesApi - factory interface
*/
export const MessagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = MessagesApiFp(configuration)
return {
/**
* Endpoint for sending text messages and picture messages using V2 messaging.
* @summary Create Message
* @param {string} accountId Your Bandwidth Account ID.
* @param {MessageRequest} messageRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createMessage(accountId: string, messageRequest: MessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Message> {
return localVarFp.createMessage(accountId, messageRequest, options).then((request) => request(axios, basePath));
},
/**
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
* @param {number} [errorCode] The error code of the message.
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [campaignId] The campaign ID of the message.
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
* @param {string} [location] Location Id associated with the message.
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
* @param {number} [fromSegmentCount] Segment count (start range).
* @param {number} [toSegmentCount] Segment count (end range).
* @param {number} [fromMessageSize] Message size (start range).
* @param {number} [toMessageSize] Message size (end range).
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<MessagesList> {
return localVarFp.listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, fromBwLatency, bwQueued, product, location, carrierQueued, fromCarrierLatency, callingNumberCountryA3, calledNumberCountryA3, fromSegmentCount, toSegmentCount, fromMessageSize, toMessageSize, sort, pageToken, limit, limitTotalCount, options).then((request) => request(axios, basePath));
},
};
};
/**
* MessagesApi - object-oriented interface
*/
export class MessagesApi extends BaseAPI {
/**
* Endpoint for sending text messages and picture messages using V2 messaging.
* @summary Create Message
* @param {string} accountId Your Bandwidth Account ID.
* @param {MessageRequest} messageRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public createMessage(accountId: string, messageRequest: MessageRequest, options?: RawAxiosRequestConfig) {
return MessagesApiFp(this.configuration).createMessage(accountId, messageRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
* @param {string} [sourceTn] The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {string} [destinationTn] The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\').
* @param {MessageStatusEnum} [messageStatus] The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
* @param {ListMessageDirectionEnum} [messageDirection] The direction of the message. One of INBOUND OUTBOUND.
* @param {string} [carrierName] The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
* @param {MessageTypeEnum} [messageType] The type of message. Either sms or mms.
* @param {number} [errorCode] The error code of the message.
* @param {string} [fromDateTime] The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [toDateTime] The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
* @param {string} [campaignId] The campaign ID of the message.
* @param {number} [fromBwLatency] The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
* @param {boolean} [bwQueued] A boolean value indicating whether the message is queued in the Bandwidth network.
* @param {ProductTypeEnum} [product] Messaging product associated with the message.
* @param {string} [location] Location Id associated with the message.
* @param {boolean} [carrierQueued] A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {number} [fromCarrierLatency] The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
* @param {string} [callingNumberCountryA3] Calling number country in A3 format.
* @param {string} [calledNumberCountryA3] Called number country in A3 format.
* @param {number} [fromSegmentCount] Segment count (start range).
* @param {number} [toSegmentCount] Segment count (end range).
* @param {number} [fromMessageSize] Message size (start range).
* @param {number} [toMessageSize] Message size (end range).
* @param {string} [sort] The field and direction to sort by combined with a colon. Direction is either asc or desc.
* @param {string} [pageToken] A base64 encoded value used for pagination of results.
* @param {number} [limit] The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
* @param {boolean} [limitTotalCount] When set to true, the response\'s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public listMessages(accountId: string, messageId?: string, sourceTn?: string, destinationTn?: string, messageStatus?: MessageStatusEnum, messageDirection?: ListMessageDirectionEnum, carrierName?: string, messageType?: MessageTypeEnum, errorCode?: number, fromDateTime?: string, toDateTime?: string, campaignId?: string, fromBwLatency?: number, bwQueued?: boolean, product?: ProductTypeEnum, location?: string, carrierQueued?: boolean, fromCarrierLatency?: number, callingNumberCountryA3?: string, calledNumberCountryA3?: string, fromSegmentCount?: number, toSegmentCount?: number, fromMessageSize?: number, toMessageSize?: number, sort?: string, pageToken?: string, limit?: number, limitTotalCount?: boolean, options?: RawAxiosRequestConfig) {
return MessagesApiFp(this.configuration).listMessages(accountId, messageId, sourceTn, destinationTn, messageStatus, messageDirection, carrierName, messageType, errorCode, fromDateTime, toDateTime, campaignId, fromBwLatency, bwQueued, product, location, carrierQueued, fromCarrierLatency, callingNumberCountryA3, calledNumberCountryA3, fromSegmentCount, toSegmentCount, fromMessageSize, toMessageSize, sort, pageToken, limit, limitTotalCount, options).then((request) => request(this.axios, this.basePath));
}
}
|