-
Notifications
You must be signed in to change notification settings - Fork 12
/
openapi.yaml
1468 lines (1440 loc) · 49.7 KB
/
openapi.yaml
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: "1.0"
title: SMS API
description: |
The SMS API enables you to send messages to your customers or
to receive messages from your customers to phone numbers registered with tyntec.
contact:
name: tyntec API Support
url: http://www.tyntec.com/support
email: support@tyntec.com
x-repository: https://github.com/tyntec/api-collection/blob/master/sms
x-major-version: v1
servers:
- url: https://api.tyntec.com/
security:
- APIKeyHeader: []
tags:
- name: SMS Messaging
description: |
tyntec’s SMS service is governed by two operations that allow you:
- to send an SMS and
- to query the status of a previously sent SMS
**Important**
tyntec stores status details for up to 3 months after the final delivery state is known.
### Delivery states
| State | Description |
| :--- | :--- |
| ACCEPTED | The message was accepted for delivery by Tyntec's platform and will be scheduled for delivery. |
| DELIVERED | Message is delivered to destination. The message has been delivered to the destination. No further deliveries will occur. |
| BUFFERED | The message is in buffered state. This is a general state used to describe a message as being active within the tyntec's platform. The message may be in retry or dispatched to a mobile network for delivery to the mobile. |
| EXPIRED | Message validity period has expired. The message has failed to be delivered within its validity period and/or retry period. No further delivery attempts will be made. |
| REJECTED | Message was rejected by the tyntec platform or destination network. Reasons for rejections can be insufficient funds, illegal content/senderId. More specific reasons are given on the `errorCode`. |
| UNDELIVERABLE | Message is undeliverable. The message has encountered a delivery error and is deemed permanently undeliverable. No further delivery attempts will be made. Certain network or platform internal errors result in the permanent non-delivery of a message. Examples of such errors would be an unknown subscriber or network error that indicated that the given destination mobile was denied SMS service or could not support SMS. More specific reasons are given on the `errorCode`.|
- name: BYON Contact Service
description: Bring Your Own Number (BYON) Contacts Service gives the users the possibility to manage their contacts.
- name: BYON Phone Book Service
description: Bring Your Own Number (BYON) Phone Book Service gives the users the possibility to view their Phone book entries.
- name: BYON Number Service
description: Bring Your Own Number (BYON) Numbers Service gives the users the possibility to register new numbers.
- name: BYON Partner Notification Service
description: API for sending notifications to the partners
- name: SMS Conversion
description: |
SMS Conversion is a term used in the SMS world to describe the messages that actually received from the end user.
tyntec is providing an endpoint for real time conversion events reporting where customers can report if a message
received or not received by the end user.
paths:
/messaging/v1/sms:
post:
tags:
- SMS Messaging
summary: Send SMS (POST)
security:
- ApiKeyHeader: []
operationId: sendSmsUsingPOST
description: |
Sends an SMS via the POST HTTP method with parameters defined in the request body.
responses:
"200":
description: The messageIds of your request
content:
application/json:
schema:
$ref: "#/components/schemas/RestMessageResponse"
"201":
description: Created
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"403":
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"404":
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"500":
description: "Something went wrong. :-("
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
requestBody:
description: Message you would like to send
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SmsMessage"
get:
tags:
- SMS Messaging
summary: Send SMS (GET)
security:
- ApiKeyHeader: []
operationId: sendSmsUsingGET
description: |
Sends an SMS via the GET HTTP method with parameters defined in the query string.
parameters:
- name: to
in: query
description: This parameter represents the receiving party’s phone number in the international phone format.
required: true
schema:
type: string
- name: from
in: query
description: |
This parameter gives the identification of the sending party, which can either be a phone number in the international format or an alphanumeric identifier with up to 11 characters.
Some destination networks impose restrictions on the sender ID format. Please check the coverage list
and contact us for more information.
required: true
schema:
type: string
- name: message
in: query
description: |
The message will be sent with characters encoded either in the GSM standard alphabet (GSM-7) or GSM Unicode alphabet (UCS-2).
- GSM standard alphabet [GSM-7](http://en.wikipedia.org/wiki/GSM_03.38). Maximum length is 160 characters per single message and 152 characters
per concatenated message.
- GSM Unicode alphabet [UCS-2](http://en.wikipedia.org/wiki/GSM_03.38). Maximum length is 70 characters per single message and 66 characters
per concatenated message.
tyntec automatically splits the sent message into concatenated messages if the message
exceeds the given limits. These concatenated messages are unified by the handset once again and
they are displayed as one message (if supported by the handset).
tyntec will charge for each part of the concatenated message as for an individual message.
required: true
schema:
type: string
- name: encoding
in: query
description: Encoding selection between GSM7, UNICODE, or the default AUTO selection
schema:
type: string
enum:
- AUTO
- GSM7
- UNICODE
default: AUTO
- name: gateway
in: query
description: Which gateway to use for the message delivery
schema:
type: string
default: DEFAULT
- name: conversion
in: query
description: Whether the message is a subject to conversion ratio
schema:
type: boolean
default: false
- name: sendDateTime
in: query
description: >-
Any future date in the format “yyyy-MM-ddT-HH:mm:ss+HH:mm” [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
If not set, the message will be sent immediately.
The default time zone is [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
schema:
type: string
- name: validity
in: query
description: Validity in minutes for this message
schema:
type: string
default: "2880"
- name: reference
in: query
description: A custom reference that will mark the Delivery Report
schema:
type: string
- name: callbackUrl
in: query
description: Your URL for delivering the Delivery Reports; leave empty for no Delivery Report.
schema:
type: string
- name: callbackMethod
in: query
description: Your prefered HTTP method for the Delivery Report callback; possible values POST/GET
schema:
type: string
- name: partLimit
in: query
description: Up to how many parts you allow this message to be concatenated
schema:
type: integer
format: int32
default: 4
- name: trate
in: query
description: >-
Up to how much you allow the transcoder to replace original
characters to make it [GSM-7](http://en.wikipedia.org/wiki/GSM_03.38)
compatible; possible values: decimals from 0 to 1
schema:
type: number
format: double
default: 1
- name: mrate
in: query
description: >-
Up to how much you allow the transcoder to skip original
characters to make it [GSM-7](http://en.wikipedia.org/wiki/GSM_03.38)
compatible; possible values: decimals from 0 to 1
schema:
type: number
format: double
default: 0
- name: upperCased
in: query
description: >-
Whether you allow the transcoder to try an upper case version of
the content in the case this improves the produced parts of the
message
schema:
type: boolean
default: true
- name: keepEmojis
in: query
description: >-
Instructs the transcoder to keep emojis or to replace them with text.
By default the transcoder will keep emojis; thus text will result to UNICODE.
schema:
type: boolean
default: true
- name: flash
in: query
description: Whether this SMS will be delivered as flash. Some networks do not support this.
schema:
type: boolean
default: false
responses:
"200":
description: The messageIds of your request
content:
application/json:
schema:
$ref: "#/components/schemas/RestMessageResponse"
"201":
description: Created
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"403":
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"404":
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"500":
description: "Something went wrong. :-("
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"/messaging/v1/messages/{requestId}":
get:
tags:
- SMS Messaging
summary: Read SMS status
security:
- ApiKeyHeader: []
operationId: getMessageInfoUsingGET
description: |
Returns the status of a sent SMS message.
You have the possibility to query the status of a message you sent through our systems.
In the case the callback URL is configured, we will POST the status to the defined URL.
**Important**
The SMS Message Status is available for 3 months after a final delivery state is reached.
parameters:
- name: requestId
in: path
description: The unique identifier provided for each request.
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RestMessageResponse"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"403":
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"404":
description: Not Found
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
"500":
description: "Something went wrong. :-("
content:
application/json:
schema:
$ref: "#/components/schemas/Problem"
/incoming:
post:
operationId: receiveMessage
summary: Receive SMS
servers:
- url: "https://example.com"
security: []
tags:
- SMS Messaging
description: |
Receive an SMS as a POST request from us to your server.
**Note:** The aforementioned path is only an example. You can choose the callback URL freely.
The SMS API allows you to automatically receive messages from your
customers sent to your phone numbers that you have registered with tyntec.
For this service, you will need to provide tyntec with an URL
(`callbackUrl`) at your webserver, e.g. `https://rest.customer.com/inboundmessages/`.
tyntec's system will do either the `POST` or `GET` call to your server;
this can be configured by tyntec.
**Retries**
tyntec's system will retry delivery every 10 seconds in the case your
application does not accept the inbound message. Retries are paused for
10 minutes after every 100 consecutive unsuccessful delivery attempts.
tyntec's system will keep trying for a maximum of 48 hours.
requestBody:
description: The message that tyntec delivers to your system
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/InboundMessage"
responses:
"2XX":
description: Message was accepted by your system.
"default":
description: |
Message was not accepted by your system.
The tyntec's inbound system will retry the delivery.
/byon/phonebook/v1/numbers:
get:
tags:
- BYON Phone Book Service
summary: List all phone numbers
description:
Returns all phone numbers created with your API key; you can specify
attributes to filter the results. The size limit is 3000.
operationId: getAllPhoneNumbersForAccountUsingGET
parameters:
- name: requestId
in: query
description: List filter based on the requestId field
required: false
schema:
type: string
- name: contactId
in: query
description: List filter based on the contactId field
required: false
schema:
type: string
- name: page
in: query
description: List filter based on the page field
required: false
schema:
type: integer
format: int32
- name: size
in: query
description: List filter based on the size field
required: false
schema:
type: integer
format: int32
maximum: 3000
responses:
"200":
description: List of phones requests
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
"/byon/phonebook/v1/numbers/{phoneNumber}":
get:
tags:
- BYON Phone Book Service
summary: Read a phone number
description: Returns details of the specific phone number entity created with your API key.
operationId: getPhoneNumberForAccountUsingGET
parameters:
- name: phoneNumber
in: path
description: Phone number to get information for
required: true
schema:
type: string
responses:
"200":
description: Phone Number entity
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
/byon/contacts/v1:
get:
tags:
- BYON Contact Service
summary: List all contacts
description:
Returns all contacts created with your API key; you can get the contact ID
from the list for editing or deleting the contact. You can specify
`friendlyName` to filter the results.
operationId: getAllContactsWithFriendlyNameUsingGET
parameters:
- name: friendlyName
in: query
description: List filter based on the friendlyName field
required: false
schema:
type: string
responses:
"200":
description: Returned the list of contacts
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ContactArrayResponse"
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/ContactArrayResponse"
"204":
description: Empty list; no contacts were found for this friendly name.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ContactArrayResponse"
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/ContactArrayResponse"
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
post:
tags:
- BYON Contact Service
summary: Create a contact
description: Creates a new contact.
operationId: createContactUsingPOST
requestBody:
$ref: "#/components/requestBodies/ContactEntity"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ContactEntity"
"*/*":
schema:
$ref: "#/components/schemas/ContactEntity"
"201":
description: Created
"202":
description: The contact was created.
content:
application/json:
schema:
$ref: "#/components/schemas/ContactEntity"
"*/*":
schema:
$ref: "#/components/schemas/ContactEntity"
"400":
description: The provided contact is not valid.
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Contact was not found.
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
"/byon/contacts/v1/{contactId}":
get:
tags:
- BYON Contact Service
summary: Read a contact
description: Returns the contact for the provided contactId.
operationId: getContactUsingGET
parameters:
- name: contactId
in: path
description: List filter based on the contactId field
required: true
schema:
type: string
responses:
"200":
description: The contact
content:
application/json:
schema:
$ref: "#/components/schemas/ContactEntity"
"*/*":
schema:
$ref: "#/components/schemas/ContactEntity"
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Contact was not found.
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
post:
tags:
- BYON Contact Service
summary: Edit a contact
description: Edits the contact for the provided contactId.
operationId: editContactUsingPOST
parameters:
- name: contactId
in: path
description: ID of the contact that is to be edited
required: true
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/ContactEntity"
responses:
"200":
description: The edited contact
content:
application/json:
schema:
$ref: "#/components/schemas/ContactEntity"
"*/*":
schema:
$ref: "#/components/schemas/ContactEntity"
"201":
description: Created
"400":
description: Contact can not be edited.
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Contact was not found.
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
delete:
tags:
- BYON Contact Service
summary: Delete a contact
description: Deletes the contact for the provided contactId.
operationId: deleteContactUsingDELETE
parameters:
- name: contactId
in: path
description: Unique identifier of the contact that is to be deleted.
required: true
schema:
type: string
responses:
"200":
description: The deleted contact
content:
application/json:
schema:
$ref: "#/components/schemas/ContactEntity"
"*/*":
schema:
$ref: "#/components/schemas/ContactEntity"
"204":
description: No Content
"400":
description: Contact can not be deleted.
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Contact was not found.
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
/byon/provisioning/v1:
get:
tags:
- BYON Number Service
summary: List all phones
description: |
Returns all phone numbers for which provisioning requests were created.
You can specify _friendlyName_ or _contactId_ for filtering the results.
operationId: getAllProvisioningPhoneNumbersForAccountUsingGET
parameters:
- name: friendlyName
in: query
description: List filter based on the friendlyName field
required: false
schema:
type: string
- name: contactId
in: query
description: List filter based on the contactId field
required: false
schema:
type: string
responses:
"200":
description: List of phone provisioning requests
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"204":
description: Empty list; no phone provisioning requests were found.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"*/*":
schema:
type: array
items:
$ref: "#/components/schemas/PhoneProvisioningArrayResponse"
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
post:
tags:
- BYON Number Service
summary: Register phones
description: New phone batch registration service for registering multiple numbers
operationId: createPhoneProvisioningRequestUsingPOST
parameters:
- name: friendlyName
in: query
description: List filter based on the friendlyName field
required: false
schema:
type: string
- name: contactId
in: query
description: List filter based on the contactId field
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PhoneNumberEntity"
description: >
Comma-separated list of phone number details:
- phoneNumber
- country (only optional if the phone number already has included the country code)
required: true
responses:
"200":
description: List of applications
content:
application/json:
schema:
$ref: "#/components/schemas/PhoneProvisioningEntity"
"*/*":
schema:
$ref: "#/components/schemas/PhoneProvisioningEntity"
"201":
description: Created
"204":
description: Empty list; no applications were found for your account.
content:
application/json:
schema:
$ref: "#/components/schemas/PhoneProvisioningEntity"
"*/*":
schema:
$ref: "#/components/schemas/PhoneProvisioningEntity"
"400":
description: Your request was not valid.
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: The contact was not found.
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
"/byon/provisioning/v1/{requestId}":
get:
tags:
- BYON Number Service
summary: Read phone status
description:
Returns the details of the provisioning request for the provided
requestId.
operationId: getProvisioningRequestUsingGET
parameters:
- name: requestId
in: path
description: Unique identifier based on the requestId field
required: true
schema:
type: string
responses:
"200":
description: Provisioning request
content:
application/json:
schema:
$ref: "#/components/schemas/PhoneProvisioningEntity"
"*/*":
schema:
$ref: "#/components/schemas/PhoneProvisioningEntity"
"400":
description: Your request was not valid.
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: The provisioning request was not found.
"500":
description: Something went wrong. :-(
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"*/*":
schema:
$ref: "#/components/schemas/ErrorResponse"
'/messaging/v1/conversion':
post:
tags:
- SMS Conversion
summary: Conversion report
security:
- APIKeyHeader: []
operationId: conversionReportPOST
description: |
Report either successful or un-successful conversion event for a message.
requestBody:
description: Conversion
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConversionEvent'
responses:
'200':
description: OK
components:
requestBodies:
ContactEntity:
content:
application/json:
schema:
$ref: "#/components/schemas/ContactEntity"
description: |
Comma-separated list of contact details:
- companyAddress (optional)
- companyName
- contactEmail
- contactName
- contactPhone
- contactTitle (optional)
- friendlyName (optional)
required: true
securitySchemes:
ApiKeyHeader:
type: apiKey
in: header
name: apikey
description: |
The API key used for this operation; we check as well that the API key has the phone number
(either on sending messages or interacting with other phone number based features) assigned.
schemas:
ContactArrayResponse:
type: object
description: Contract Array Response schema
properties:
contacts:
type: array
items:
$ref: "#/components/schemas/ContactEntity"
size:
type: integer
format: int32
ContactEntity:
type: object
description: Contract Entity schema
properties:
companyAddress:
description: Company's postal address
type: string
companyName:
description: Company's name
type: string
contactEmail:
description: E-mail address
type: string
contactName:
description: Requestor's name
type: string
contactPhone:
description: Requestor's phone number
type: string
contactTitle:
description: Requestor's title
type: string
friendlyName:
description: List filter based on the friendlyName field
type: string
ConversionEvent:
type: object
description: This is the event were delivery information regarding the message can be reported back to tyntec
required:
- requestId
properties: