You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/openapi.yaml
+62-45Lines changed: 62 additions & 45 deletions
Original file line number
Diff line number
Diff line change
@@ -322,8 +322,8 @@ paths:
322
322
schema:
323
323
type: string
324
324
style: simple
325
-
- description: |
326
-
General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
325
+
- description: General-header field is used to specify directives that MUST
326
+
be obeyed by all caching mechanisms along the request/response chain.
327
327
example: no-cache
328
328
explode: false
329
329
in: header
@@ -408,8 +408,11 @@ paths:
408
408
schema:
409
409
type: string
410
410
style: simple
411
-
- description: |
412
-
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.
411
+
- description: "The ID of the message to search for. Special characters need\
412
+
\ to be encoded using URL encoding. Message IDs could come in different\
413
+
\ formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2\
414
+
\ are valid message ID formats. Note that you must include at least one\
415
+
\ query parameter."
413
416
example: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6
414
417
explode: true
415
418
in: query
@@ -418,8 +421,10 @@ paths:
418
421
schema:
419
422
type: string
420
423
style: form
421
-
- description: |
422
-
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').
424
+
- description: "The phone number that sent the message. Accepted values are:\
425
+
\ a single full phone number a comma separated list of full phone numbers\
426
+
\ (maximum of 10) or a single partial phone number (minimum of 5 characters\
427
+
\ e.g. '%2B1919')."
423
428
example: '%2B15554443333'
424
429
explode: true
425
430
in: query
@@ -428,8 +433,10 @@ paths:
428
433
schema:
429
434
type: string
430
435
style: form
431
-
- description: |
432
-
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').
436
+
- description: "The phone number that received the message. Accepted values\
437
+
\ are: a single full phone number a comma separated list of full phone numbers\
438
+
\ (maximum of 10) or a single partial phone number (minimum of 5 characters\
439
+
\ e.g. '%2B1919')."
433
440
example: '%2B15554443333'
434
441
explode: true
435
442
in: query
@@ -438,8 +445,8 @@ paths:
438
445
schema:
439
446
type: string
440
447
style: form
441
-
- description: |
442
-
The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
448
+
- description: The status of the message. One of RECEIVED QUEUED SENDING SENT
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).
465
+
- description: The name of the carrier used for this message. Possible values
466
+
include but are not limited to Verizon and TMobile. Special characters need
467
+
to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
460
468
example: Verizon
461
469
explode: true
462
470
in: query
@@ -482,8 +490,8 @@ paths:
482
490
schema:
483
491
type: integer
484
492
style: form
485
-
- description: |
486
-
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.
493
+
- description: The start of the date range to search in ISO 8601 format. Uses
494
+
the message receive time. The date range to search in is currently 14 days.
487
495
example: 2022-09-14T18:20:16.000Z
488
496
explode: true
489
497
in: query
@@ -492,8 +500,8 @@ paths:
492
500
schema:
493
501
type: string
494
502
style: form
495
-
- description: |
496
-
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.
503
+
- description: The end of the date range to search in ISO 8601 format. Uses
504
+
the message receive time. The date range to search in is currently 14 days.
497
505
example: 2022-09-14T18:20:16.000Z
498
506
explode: true
499
507
in: query
@@ -530,8 +538,8 @@ paths:
530
538
schema:
531
539
type: string
532
540
style: form
533
-
- description: |
534
-
The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
541
+
- description: The maximum records requested in search result. Default 100.
542
+
The sum of limit and after cannot be more than 10000.
535
543
example: 50
536
544
explode: true
537
545
in: query
@@ -5017,8 +5025,8 @@ components:
5017
5025
type: string
5018
5026
style: simple
5019
5027
cacheControl:
5020
-
description: |
5021
-
General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
5028
+
description: General-header field is used to specify directives that MUST be
5029
+
obeyed by all caching mechanisms along the request/response chain.
5022
5030
example: no-cache
5023
5031
explode: false
5024
5032
in: header
@@ -5038,8 +5046,11 @@ components:
5038
5046
type: string
5039
5047
style: simple
5040
5048
messageId:
5041
-
description: |
5042
-
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.
5049
+
description: "The ID of the message to search for. Special characters need to\
5050
+
\ be encoded using URL encoding. Message IDs could come in different formats,\
5051
+
\ e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2\
5052
+
\ are valid message ID formats. Note that you must include at least one query\
5053
+
\ parameter."
5043
5054
example: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6
5044
5055
explode: true
5045
5056
in: query
@@ -5049,8 +5060,9 @@ components:
5049
5060
type: string
5050
5061
style: form
5051
5062
sourceTn:
5052
-
description: |
5053
-
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').
5063
+
description: "The phone number that sent the message. Accepted values are: a\
5064
+
\ single full phone number a comma separated list of full phone numbers (maximum\
5065
+
\ of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919')."
5054
5066
example: '%2B15554443333'
5055
5067
explode: true
5056
5068
in: query
@@ -5060,8 +5072,10 @@ components:
5060
5072
type: string
5061
5073
style: form
5062
5074
destinationTn:
5063
-
description: |
5064
-
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').
5075
+
description: "The phone number that received the message. Accepted values are:\
5076
+
\ a single full phone number a comma separated list of full phone numbers\
5077
+
\ (maximum of 10) or a single partial phone number (minimum of 5 characters\
5078
+
\ e.g. '%2B1919')."
5065
5079
example: '%2B15554443333'
5066
5080
explode: true
5067
5081
in: query
@@ -5071,8 +5085,8 @@ components:
5071
5085
type: string
5072
5086
style: form
5073
5087
messageStatus:
5074
-
description: |
5075
-
The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
5088
+
description: The status of the message. One of RECEIVED QUEUED SENDING SENT
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).
5107
+
description: The name of the carrier used for this message. Possible values
5108
+
include but are not limited to Verizon and TMobile. Special characters need
5109
+
to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
5095
5110
example: Verizon
5096
5111
explode: true
5097
5112
in: query
@@ -5120,8 +5135,8 @@ components:
5120
5135
type: integer
5121
5136
style: form
5122
5137
fromDateTime:
5123
-
description: |
5124
-
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.
5138
+
description: The start of the date range to search in ISO 8601 format. Uses
5139
+
the message receive time. The date range to search in is currently 14 days.
5125
5140
example: 2022-09-14T18:20:16.000Z
5126
5141
explode: true
5127
5142
in: query
@@ -5131,8 +5146,8 @@ components:
5131
5146
type: string
5132
5147
style: form
5133
5148
toDateTime:
5134
-
description: |
5135
-
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.
5149
+
description: The end of the date range to search in ISO 8601 format. Uses the
5150
+
message receive time. The date range to search in is currently 14 days.
5136
5151
example: 2022-09-14T18:20:16.000Z
5137
5152
explode: true
5138
5153
in: query
@@ -5173,8 +5188,8 @@ components:
5173
5188
type: string
5174
5189
style: form
5175
5190
limit:
5176
-
description: |
5177
-
The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
5191
+
description: The maximum records requested in search result. Default 100. The
5192
+
sum of limit and after cannot be more than 10000.
5178
5193
example: 50
5179
5194
explode: true
5180
5195
in: query
@@ -6177,8 +6192,8 @@ components:
6177
6192
example: default
6178
6193
type: string
6179
6194
messageStatusEnum:
6180
-
description: |
6181
-
The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
6195
+
description: The status of the message. One of RECEIVED QUEUED SENDING SENT
6196
+
FAILED DELIVERED ACCEPTED UNDELIVERED.
6182
6197
enum:
6183
6198
- RECEIVED
6184
6199
- QUEUED
@@ -6504,8 +6519,8 @@ components:
6504
6519
format: date-time
6505
6520
type: string
6506
6521
segmentCount:
6507
-
description: |
6508
-
The number of segments the original message from the user is broken into before sending over to carrier networks.
6522
+
description: The number of segments the original message from the user is
6523
+
broken into before sending over to carrier networks.
6509
6524
example: 2
6510
6525
type: integer
6511
6526
direction:
@@ -6523,8 +6538,10 @@ components:
6523
6538
example: "+15553332222"
6524
6539
type: string
6525
6540
media:
6526
-
description: |
6527
-
The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name.
6541
+
description: The list of media URLs sent in the message. Including a `filename`
6542
+
field in the `Content-Disposition` header of the media linked with a URL
6543
+
will set the displayed file name. This is a best practice to ensure that
\ _ and ampersand &. Alphanumeric Sender IDs must contain at least one\
6574
-
\ letter.\n"
6591
+
\ letter."
6575
6592
example: "+15551113333"
6576
6593
type: string
6577
6594
text:
@@ -6581,7 +6598,7 @@ components:
6581
6598
maxLength: 2048
6582
6599
type: string
6583
6600
media:
6584
-
description: |
6601
+
description: |-
6585
6602
A list of URLs to include as media attachments as part of the message.
6586
6603
Each URL can be at most 4096 characters.
6587
6604
example:
@@ -6600,7 +6617,7 @@ components:
6600
6617
priority:
6601
6618
$ref: '#/components/schemas/priorityEnum'
6602
6619
expiration:
6603
-
description: |
6620
+
description: |-
6604
6621
A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.
0 commit comments