/
Smshosting_REST_API.postman_collection_2021.json
9003 lines (9003 loc) · 357 KB
/
Smshosting_REST_API.postman_collection_2021.json
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
{
"info": {
"_postman_id": "d61c32e4-e8bd-4c21-9b9c-67f1991b4eb0",
"name": "Smshosting REST API",
"description": "Grazie alle REST API puoi integrare il tuo software con il nostro gateway in modo **semplice** e **rapido**.\n\nLe REST API si basano sui metodi HTTP quindi per l'integrazione potrai utilizzare un Client HTTP scritto in un **qualsiasi linguaggio di programmazione**.\n\nTramite le REST API sono possibili le seguenti operazioni:\n\n* inviare sms singoli e campagne\n* inviare campagne email\n* cercare e visualizzare il dettaglio degli sms inviati\n* cercare e visualizzare gli sms ricevuti con il servizio di ricezione\n* visualizzare i dati relativi al proprio profilo su Smsosting.it\n* gestire i contatti ed i gruppi della rubrica\n* gestire le Fidelity Card\n* gestire i Coupon\n\n## Prima di iniziare\nSe non lo hai già fatto [registrati a Smshosting.it](https://cloud.smshosting.it/sms/signupInit.ic) in modo completamente gratuito.\n\n## Url base dei servizi\nL'indirizzo base da utilizzare per accedere alle REST API è il seguente\n\n`https://api.smshosting.it/rest/api`\n\noppure per i rivenditori\n\n`https://api.smstools.it/rest/api`\n\n---\n\n**Per motivi di sicurezza le REST API utilizzano il solo protocollo HTTPS (il protocollo HTTP non è supportato)**.\n\n---\n\n# Effettuare una richiesta\n## Autenticazione\nTutte le richiesta alle REST API necessitano di essere autenticate attraverso il meccanismo della **HTTP Basic authentication**.\n\nLo username e la password da fornire sono i codici **AUTH_KEY** e **AUTH_SECRET** associati al tuo profilo su [Smshosting.it](https://www.smshosting.it), visita la sezione [gestione sicurezza API](https://cloud.smshosting.it/sms/user/securityApiInit.ic) nella tua area privata per recuperali.\n\nPuoi testare le tue credenziali chiamando semplicemente da **browser** il seguente URL:\n\n`https://AUTH_KEY:AUTH_SECRET@api.smshosting.it/rest/api/user`\n\noppure eseguendo da shell Linux il comando\n\n`curl --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user`\n\nNel caso l'autenticazione non vada a buon fine viene restituito l'errore HTTP 401.\n\n## Econding e Content-Type\nTutte le richieste alle REST API **devono** avere come encoding UTF-8.\n\nLe richieste in **HTTP POST** e **HTTP PUT** devono avere come **Content-Type** nell'header `application/x-www-form-urlencoded` se non indicato diversamente.\n\n## Scegliere il formato di risposta\nLe REST API di [Smshosting.it](https://www.smshosting.it) possono restituire le infomazioni sia nel formato **JSON** (default) che **XML**.\n\nPer ottenere la risposta nel formato desiderato utilizza l'header HTTP \"**Accept**\" nella tua richiesta.\n\n- **Accept:application/json** per ottenere un JSON\n\n`curl -H \"Accept: application/json\" --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user`\n\n- **Accept:application/xml** per ottenere un XML\n\n`curl -H \"Accept: application/xml\" --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/user`\n\n# Gestire la risposta\n## Codici di risposta (HTTP Status Code)\nPer ogni richiesta le REST API restituiscono uno dei seguenti **HTTP Status Code**:\n\n* `200` - Richiesta completata correttamente\n* `204` - Richiesta completata correttamente. Risorsa eliminata.\n* `400` - Parametro mancante\n* `401` - Autenticazione fallita\n* `404` - Risorsa non trovata\n* `405` - Metodo HTTP non consentito\n* `500` - Errore imprevisto del server\n\n## Contenuto risposta\nAd ogni chiamata **HTTP GET** e **HTTP POST** completata con successo (**HTTP status uguale a 200**) le REST API restituiscono come contenuto un JSON/XML.\n\nIn caso di chiamata **HTTP PUT** e **HTTP DELETE** completata con successo (**HTTP status uguale a 200 o 204**) il contenuto della risposta sarà invece vuoto.\n\nSe una chiamata dovesse terminare con un errore (**HTTP status diverso da 200 o 204**) viene resituito un JSON/XML esplicativo dell'errore avvenuto:\n\n* `errorCode` - Codice HTTP status\n* `errorMsg` - Codice di errore esplicativo del problema occorso\n\nAd esempio nel caso l'autenticazione fallisca le REST API restituiscono un HTTP Status 401 e come contenuto:\n\n```\n{\n \"errorMsg\":\"BAD_CREDENTIALS\",\n \"errorCode\":401\n}\n```\n\n## Paginazione\nAlcune risorse (ricerca sms inviati o ricevuti, ricerca contatti, etc.) restituiscono i risultati paginati.\n\nAd esempio la ricerca sms inviati restituisce il seguente JSON\n\n```\n{\n \"metadata\":{\n \"count\":1,\n \"offset\":0,\n \"limit\":20\n },\n \"smsList\":[\n {\n \"id\":389395385,\n \"to\":\"393480000000\",\n \"text\":\"Test Sms\",\n \"from\":\"mrossi\",\n \"status\":\"DELIVERED\",\n \"insertDate\":\"2014-01-13T15:01:35+0100\",\n \"sentDate\":\"2014-01-13T15:01:37+0100\",\n \"deliveryDate\":\"2014-01-13T15:01:40+0100\",\n \"transactionId\":\"72810108d4114097b9edb42b255b273c\",\n \"price\":0.0945\n }\n ]\n}\n```\n\nIl campo `metadata` contiene le informazioni utili a gestire la paginazione dei risultati.\n\nLa proprietà `count` indica il numero totale di risultati trovati per quella ricerca.\n\nI campi `offset` e `limit` indicano rispettivamente l'indice del primo risultato ed il numero di risultati restituiti dalla chiamata.\n\n`offset` e `limit` possono essere usati come parametri nella richiesta in modo da controllare il range di risultati restituiti.\n\nAd esempio se una ricerca trova 100 risultati e la dimensione della pagina è di 20 elementi\n\n```\n{\n \"metadata\":{\n \"count\":100,\n \"offset\":0,\n \"limit\":20\n },\n .......\n}\n```\n\nsarà possibile ottenere 5 pagine usando i seguenti valori di `offset` e `limit`:\n\n- pagina 1 - `offset=0&limit=20`\n- pagina 2 - `offset=20&limit=20`\n- pagina 3 - `offset=40&limit=20`\n- pagina 4 - `offset=60&limit=20`\n- pagina 5 - `offset=80&limit=20`\n\n# Librerie\n\n## Java\nTi permette di integrare i nostri servizi nei tuoi progetti _Java_, aggiungendo la possibilità di inviare SMS, Email, gestire clienti e molto di più.\n[Vedi sorgenti](https://github.com/smshosting/smshosting-api-java-client)\n\n## PHP\nIntegra nel tuo progetto PHP le funzionalità di Smshosting.\n[Vedi sorgenti](https://github.com/smshosting/smshosting-api-php-client)\n\n## C#\nLibreria C# che ti permette di integrare Smshosting nei tuoi progetti: SMS, Email, gestire clienti e molto di più. Puoi trovarla su [Github](https://github.com/smshosting/smshosting-api-cs-client) o [NuGet](https://www.nuget.org/packages?q=smshosting)\n\n# Note\n[1]: Valorizzare almeno uno tra questi parametri",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Invio SMS",
"item": [
{
"name": "Invio SMS",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "from",
"value": "www.smshosting.it",
"description": "[String] *(Opzionale)*\n\nIl mittente dell'SMS.\n\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.\n\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.\n\n**I mittenti non verificati verranno rimpiazzati con un mittente numerico casuale**.",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "[String] _(Opzionale valorizzare almeno uno tra **to** e **group**)_\n\nIl destinatario del messaggio.\n\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare **più numeri di telefono** (max 1000 numeri) separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n`393481234567` oppure `393481234567,393481234568,393481234568`\n\nAlternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).\n\nAd esempio:\n\n**[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]**\n",
"type": "text"
},
{
"key": "group",
"value": "gruppo",
"description": "[String] _(Opzionale valorizzare almeno uno tra **to** e **group**)_\n\n**Id** del gruppo in Rubrica al quale inviare\n\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".\n\nAd esempio se nellla rubrica sono presenti i gruppi Amici (`id=1`) e Scuola (`id=2`) sarà possibile indicare:\n\n**1** oppure **1,2**",
"type": "text",
"disabled": true
},
{
"key": "text",
"value": "sms di test",
"description": "[String] *(Obbligatorio)*\n\nTesto del messaggio.\nSe il messaggio supera i 160 caratteri vengono inviati [più sms concatenati](https://help.smshosting.it/it/invio-sms/caratteristiche-sms/lunghezza-testo-e-codifiche-supportate) fino ad una massimo di 7.\n\nIl testo può contenere dei **placeholder** che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi **${nome proprietà}**\n\nNel caso il testo contenga dei **placeholder** il campo **to** deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.\n\nAd esempio:\nto=[{msisdn:'393481234567',**nome:'Mario Rossi'**},{msisdn:'393481234568',**nome:'Luigi Bianchi'**}]\ntext=Invio sms di test a **${nome}**",
"type": "text"
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "[String] *(Opzionale)*\n\nData (in formato **yyyy-MM-ddTHH:mm:ssZ**) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).\n\nAd esempio:\n**2014-12-25T08:00:00+0200** indica il 25/12/2014 alle 08:00:00 riferito al GMT +2",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "[String] *(Opzionale)*\n\nUn identificatore personale dell'invio.\n\nConsente di assegnare a tutti gli sms inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. **Massimo 60 caratteri**.",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "[String] *(Opzionale)*\n\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.\n\nPossibili valori **true/false**",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "[String] *(Opzionale)*\n\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) dell'SMS.\n\n[Gestione statusCallback](https://help.smshosting.it/it/docs/sms-rest-api/invio#ref5)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "[String] *(Opzionale)*\n\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:\n\n* **7BIT** - Encoding **standard** per i messaggi GSM. La lunghezza massima per un singolo sms è di **160 caratteri**.\n\n* **UCS2** - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di **70 caratteri**.\n\n* **AUTO** - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.\n\n**Default : 7BIT**",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/send",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"send"
]
},
"description": "Invio di un sms ad uno o più destinatari singoli o verso uno o più gruppi della rubrica.\n\nÈ possibile testare l'invio valorizzando il parametro `sandbox` a `true` nella richiesta.\n\nIl parametro `statusCallback` consente di registrare un URL al quale sarà inviata via HTTP una notifica con lo stato (Consegnato, Non Consegnato, ecc...) dell'SMS.\n\n## Richiesta\n\n> _Il \"**Content-Type**\" per questa richiesta POST deve essere \"**application/x-www-form-urlencoded**\"_\n\n## HTTP Status Codes\n|Codice|Descrizione|\n|--- |--- |\n|200|ok|\n|400|Parametri non validi<br>I possibili errorMsg sono:<br>`BAD_TRANSACTIONID` - parametro transactionId non valido<br>`BAD_DATE` - formato data differito non valida<br>`BAD_TEXT` - parametro text non valido<br>`BAD_TEXT_PLACEHOLDER` - text contiene dei placeholder non sostituibili<br>`BAD_CALLBACK` - parametro statusCallback non valido<br>`BAD_ENCODING` - parametro encoding non valido<br>`BAD_FROM` - parametro from non valido<br>`BAD_GROUP` - parametro group non valido<br>`BAD_CREDIT` - credito insufficiente per effetturare l'invio<br>`NO_VALID_RECIPIENT` - nessun valido destinatario<br>`GENERIC_ERROR` - errore interno al server|\n|401|Credenziali non valide|\n|405|Metodo HTTP non consentito|\n|500|Errore generico|\n\n## Descrizione Risposta\n|Proprietà|Descrizione|\n|--- |--- |\n|from|Il mittente del messaggio.|\n|text|Testo Sms|\n|transactionId|identificatore dell'invio<br>Se non specificato in fase di richiesta verrà generato un **transactionId** automaticamente dalle REST API|\n|smsInserted|Numero Sms inseriti|\n|smsNotInserted|Numero Sms Non inseriti|\n|sms|Lista degli Sms.<br>Ogni sms è descritto dalla proprietà:<br>`to` - numero di cellulare al quale è stato inviato il messaggio<br>`id` - id interno del messaggio. Utile per richiedere lo stato del messaggio con la funzione di Cerca Sms<br>`status` - Stato del messaggio. Viene valorizzato ad `INSERTED` nel caso il messaggio sia inserito correttamente, a `NOT_INSERTED` in caso contrario.<br>`statusDetail` - nel caso il messaggio non venga inserito (status = `NOT_INSERTED`) questo campo riporta un messaggio esplicativo dell'errore avvenuto. I possibili valori sono:<br> `BADNUMBERFORMAT` - Numero del destinatario non corretto<br> `DUPLICATESMS` - Sms già inserito nelle ultime 24 ore con identico destinatario, mittente e testo.<br> `BLACKLIST` - Il destinatario è stato inserito nella blacklist.|"
},
"response": [
{
"name": "Invio SMS OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Authorization",
"value": "Basic AAAxxxxxxxxxxxxxxxxxxx",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "from",
"value": "www.smshosting.it",
"description": "[String] *Opzionale*\n\nIl mittente dell'SMS.\n\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.\n\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.\n\n**I mittenti non verificati verranno rimpiazzati con un mittente numerico casuale**.",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "[String] _Opzionale (valorizzare almeno uno tra **to** e **group**)_\n\nIl destinatario del messaggio.\n\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare **più numeri di telefono** (max 1000 numeri) separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n`393481234567` oppure `393481234567,393481234568,393481234568`\n\nAlternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).\n\nAd esempio:\n\n**[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]**\n",
"type": "text"
},
{
"key": "group",
"value": "gruppo",
"description": "[String] _Opzionale (valorizzare almeno uno tra **to** e **group**)_\n\n**Id** del gruppo in Rubrica al quale inviare\n\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".\n\nAd esempio se nellla rubrica sono presenti i gruppi Amici (`id=1`) e Scuola (`id=2`) sarà possibile indicare:\n\n**1** oppure **1,2**",
"type": "text",
"disabled": true
},
{
"key": "text",
"value": "sms di test",
"description": "[String] *(Obbligatorio)*\n\nTesto del messaggio.\nSe il messaggio supera i 160 caratteri vengono inviati [più sms concatenati](https://help.smshosting.it/it/invio-sms/caratteristiche-sms/lunghezza-testo-e-codifiche-supportate) fino ad una massimo di 7.\n\nIl testo può contenere dei **placeholder** che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi **${nome proprietà}**\n\nNel caso il testo contenga dei **placeholder** il campo **to** deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.\n\nAd esempio:\nto=[{msisdn:'393481234567',**nome:'Mario Rossi'**},{msisdn:'393481234568',**nome:'Luigi Bianchi'**}]\ntext=Invio sms di test a **${nome}**",
"type": "text"
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "[String] *(Opzionale)*\n\nData (in formato **yyyy-MM-ddTHH:mm:ssZ**) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).\n\nAd esempio:\n**2014-12-25T08:00:00+0200** indica il 25/12/2014 alle 08:00:00 riferito al GMT +2",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "[String] *(Opzionale)*\n\nUn identificatore personale dell'invio.\n\nConsente di assegnare a tutti gli sms inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. **Massimo 60 caratteri**.",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "[String] *(Opzionale)*\n\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.\n\nPossibili valori **true/false**",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "[String] *(Opzionale)*\n\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) dell'SMS.\n\n[Gestione statusCallback](https://help.smshosting.it/it/docs/sms-rest-api/invio#ref5)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "[String] *(Opzionale)*\n\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:\n\n* **7BIT** - Encoding **standard** per i messaggi GSM. La lunghezza massima per un singolo sms è di **160 caratteri**.\n\n* **UCS2** - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di **70 caratteri**.\n\n* **AUTO** - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.\n\n**Default : 7BIT**",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/send",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"send"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [],
"cookie": [],
"body": "{\n \"from\": \"mrossi\",\n \"text\": \"Test Sms\",\n \"transactionId\": \"d41ebeeb38b6a04818aa707818d3161e\",\n \"smsInserted\": 1,\n \"smsNotInserted\": 0,\n \"sms\": [\n {\n \"id\": 389310742,\n \"to\": \"393412345678\",\n \"status\": \"INSERTED\"\n }\n ]\n}"
},
{
"name": "Invio SMS Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "from",
"value": "www.smshosting.it",
"description": "[String] *(Opzionale)*\n\nIl mittente dell'SMS.\n\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.\n\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.\n\n**I mittenti non verificati verranno rimpiazzati con un mittente numerico casuale**.",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "[String] _(Opzionale valorizzare almeno uno tra **to** e **group**)_\n\nIl destinatario del messaggio.\n\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare **più numeri di telefono** (max 1000 numeri) separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n`393481234567` oppure `393481234567,393481234568,393481234568`\n\nAlternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).\n\nAd esempio:\n\n**[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]**\n",
"type": "text",
"disabled": true
},
{
"key": "group",
"value": "gruppo",
"description": "[String] _(Opzionale valorizzare almeno uno tra **to** e **group**)_\n\n**Id** del gruppo in Rubrica al quale inviare\n\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".\n\nAd esempio se nellla rubrica sono presenti i gruppi Amici (`id=1`) e Scuola (`id=2`) sarà possibile indicare:\n\n**1** oppure **1,2**",
"type": "text",
"disabled": true
},
{
"key": "text",
"value": "sms di test",
"description": "[String] *(Obbligatorio)*\n\nTesto del messaggio.\nSe il messaggio supera i 160 caratteri vengono inviati [più sms concatenati](https://help.smshosting.it/it/invio-sms/caratteristiche-sms/lunghezza-testo-e-codifiche-supportate) fino ad una massimo di 7.\n\nIl testo può contenere dei **placeholder** che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi **${nome proprietà}**\n\nNel caso il testo contenga dei **placeholder** il campo **to** deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.\n\nAd esempio:\nto=[{msisdn:'393481234567',**nome:'Mario Rossi'**},{msisdn:'393481234568',**nome:'Luigi Bianchi'**}]\ntext=Invio sms di test a **${nome}**",
"type": "text"
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "[String] *(Opzionale)*\n\nData (in formato **yyyy-MM-ddTHH:mm:ssZ**) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).\n\nAd esempio:\n**2014-12-25T08:00:00+0200** indica il 25/12/2014 alle 08:00:00 riferito al GMT +2",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "[String] *(Opzionale)*\n\nUn identificatore personale dell'invio.\n\nConsente di assegnare a tutti gli sms inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. **Massimo 60 caratteri**.",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "[String] *(Opzionale)*\n\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.\n\nPossibili valori **true/false**",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "[String] *(Opzionale)*\n\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) dell'SMS.\n\n[Gestione statusCallback](https://help.smshosting.it/it/docs/sms-rest-api/invio#ref5)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "[String] *(Opzionale)*\n\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:\n\n* **7BIT** - Encoding **standard** per i messaggi GSM. La lunghezza massima per un singolo sms è di **160 caratteri**.\n\n* **UCS2** - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di **70 caratteri**.\n\n* **AUTO** - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.\n\n**Default : 7BIT**",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/send",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"send"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-type",
"value": "application/json"
},
{
"key": "content-length",
"value": "49"
},
{
"key": "date",
"value": "Wed, 21 Apr 2021 08:29:31 GMT"
}
],
"cookie": [],
"body": "{\n \"errorMsg\": \"NO_VALID_RECIPIENT\",\n \"errorCode\": 400\n}"
},
{
"name": "Invio SMS Error Encoding",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/send",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"send"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-type",
"value": "application/json"
},
{
"key": "content-length",
"value": "44"
},
{
"key": "date",
"value": "Wed, 21 Apr 2021 08:32:09 GMT"
}
],
"cookie": [],
"body": "{\n \"errorMsg\": \"GENERIC_ERROR\",\n \"errorCode\": 500\n}"
},
{
"name": "Invio SMS Wrong Auth",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Basic AAAxxxxxxxxxxxxxxxxxxx",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "from",
"value": "www.smshosting.it",
"description": "[String] *(Opzionale)*\n\nIl mittente dell'SMS.\n\nPuò essere un numero di telefono validato oppure una stringa alfanumerica di massimo 11 caratteri. Se non specificato viene usato il mittente di default del proprio profilo.\n\nPer utilizzare un mittente alfanumerico è obbligatoria la registrazione dello stesso, questa procedura può essere effettuata dal nostro pannello web oppure via API.\n\n**I mittenti non verificati verranno rimpiazzati con un mittente numerico casuale**.",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "[String] _(Opzionale valorizzare almeno uno tra **to** e **group**)_\n\nIl destinatario del messaggio.\n\nDeve essere un numero di cellulare compreso di prefisso internazionale.\nÈ possibile specificare **più numeri di telefono** (max 1000 numeri) separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n`393481234567` oppure `393481234567,393481234568,393481234568`\n\nAlternativamente il parametro può essere valorizzato con un array JSON contenente gli oggetti che descrivono il destinatario.\nOgni oggetto deve avere obbligatoriamente la propriertà msisdn valorizzata.\nLe altre proprietà di tali oggetti posso essere utilizzate per parametrizzare il testo del messaggio (vedi il campo text).\n\nAd esempio:\n\n**[{msisdn:'393481234567'},{msisdn:'393481234568'},{msisdn:'393481234568'}]**\n",
"type": "text"
},
{
"key": "group",
"value": "gruppo",
"description": "[String] _(Opzionale valorizzare almeno uno tra **to** e **group**)_\n\n**Id** del gruppo in Rubrica al quale inviare\n\nÈ possibile specificare più gruppi della rubrica separandoli con il carattere virgola \",\".\n\nAd esempio se nellla rubrica sono presenti i gruppi Amici (`id=1`) e Scuola (`id=2`) sarà possibile indicare:\n\n**1** oppure **1,2**",
"type": "text",
"disabled": true
},
{
"key": "text",
"value": "sms di test",
"description": "[String] *(Obbligatorio)*\n\nTesto del messaggio.\nSe il messaggio supera i 160 caratteri vengono inviati [più sms concatenati](https://help.smshosting.it/it/invio-sms/caratteristiche-sms/lunghezza-testo-e-codifiche-supportate) fino ad una massimo di 7.\n\nIl testo può contenere dei **placeholder** che saranno sostituiti in fase di invio dai valori associati al rispettivo destinatario.\nIl placeholder va specificato con la sintassi **${nome proprietà}**\n\nNel caso il testo contenga dei **placeholder** il campo **to** deve essere valorizzato con un array JSON ed ogni oggetto dell'array deve contenere la proprietà indicata nel placeholder.\n\nAd esempio:\nto=[{msisdn:'393481234567',**nome:'Mario Rossi'**},{msisdn:'393481234568',**nome:'Luigi Bianchi'**}]\ntext=Invio sms di test a **${nome}**",
"type": "text"
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "[String] *(Opzionale)*\n\nData (in formato **yyyy-MM-ddTHH:mm:ssZ**) nella quale sarà inviato il messaggio. Se non specificato, il messaggio è inviato immediatamente.\nIl carattere **Z** indica il timezone nel formato RFC 822 4-digit. (Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno).\n\nAd esempio:\n**2014-12-25T08:00:00+0200** indica il 25/12/2014 alle 08:00:00 riferito al GMT +2",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "[String] *(Opzionale)*\n\nUn identificatore personale dell'invio.\n\nConsente di assegnare a tutti gli sms inviati con una chiamata lo stesso identificatore in modo da utilizzare questo parametro per ricevere lo stato dei messaggi. **Massimo 60 caratteri**.",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "[String] *(Opzionale)*\n\nConsente di fare la chiamata senza inviare effettivamente il messaggio.\nParametro utile in fase di sviluppo di eventuali integrazioni con le REST API.\n\nPossibili valori **true/false**",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "[String] *(Opzionale)*\n\nURL al quale sarà inviata via HTTP/HTTPS una notifica con lo stato (Consegnato, Non Consegnato) dell'SMS.\n\n[Gestione statusCallback](https://help.smshosting.it/it/docs/sms-rest-api/invio#ref5)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "[String] *(Opzionale)*\n\nL'encoding da utilizzare per il testo del messaggio.\nI possibili valori sono:\n\n* **7BIT** - Encoding **standard** per i messaggi GSM. La lunghezza massima per un singolo sms è di **160 caratteri**.\n\n* **UCS2** - Encoding a 8-bit per inviare messaggi GSM con contenuto non ASCII. La lunghezza massima per un singolo sms è di **70 caratteri**.\n\n* **AUTO** - L'encoding da utilizzare viene automaticamente identificato in base al contenuto del campo testo.\n\n**Default : 7BIT**",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/send",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"send"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "www-authenticate",
"value": "Basic realm=\"REST API Authentication\""
},
{
"key": "content-type",
"value": "application/json"
},
{
"key": "content-length",
"value": "46"
},
{
"key": "date",
"value": "Wed, 21 Apr 2021 08:34:59 GMT"
}
],
"cookie": [],
"body": "{\n \"errorMsg\": \"BAD_CREDENTIALS\",\n \"errorCode\": 401\n}"
}
]
},
{
"name": "Invio SMS bulk",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "transactionCallback",
"value": "",
"description": "[String] *(Opzionale)*\n\nURL al quale sarà inviata via HTTP una notifica con lo stato complessivo dell'invio\n[Gestione notificationCallback](#32ddccbd-f896-924a-b9df-7d716a8e4d9d)",
"type": "text",
"disabled": true
},
{
"key": "from",
"value": "www.SmsH.it",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "group",
"value": "gruppo",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "text",
"value": "sms di test",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/sendbulk",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"sendbulk"
]
},
"description": "Modalità di invio sms asincrono da utilizzare con un numero elevato di destinatari (Più di 1000 destinatari per singola richiesta).\n\nUna volta inviata la richiesta viene restituito un **transactionId** utile a identificare sucessivamente gli sms.\n\nNel caso l'invio non possa essere completato a causa di un errore verrà inviata un'email contentente il codice di errore.\n\n_**Nota**: Se invii fino a 1000 destinatari per singola richiesta ti consigliamo di utilizzare la funzione di [Invio SMS](#cd64e428-8ad3-e00b-7036-f0de86ffc697)_\n\n## Richiesta\n\n> _Il \"**Content-Type**\" per questa richiesta POST deve essere \"**application/x-www-form-urlencoded**\"_\n\n## HTTP Status Codes\n\n|Codice|Descrizione|\n|--- |--- |\n|`200`|ok|\n|`400`|Parametri non validi<br>I possibili errorMsg sono:<br>`BAD_TRANSACTIONID` - parametro **transactionId** non valido<br>`BAD_DATE` - formato data differito non valida<br>`BAD_TEXT` - parametro **text** non valido<br>`BAD_TEXT_PLACEHOLDER` - **text** contiene dei placeholder non sostituibili<br>`BAD_CALLBACK` - parametro **statusCallback** non valido<br>`BAD_ENCODING` - parametro **encoding** non valido<br>`BAD_FROM` - parametro **from** non valido<br>`BAD_GROUP` - parametro **group** non valido<br>`BAD_CREDIT` - credito insufficiente per effetturare l'invio<br>`NO_VALID_RECIPIENT` - nessun valido destinatario<br>`GENERIC_ERROR` - errore interno al server|\n|`401`|Credenziali non valide|\n|`405`|Metodo HTTP non consentito|\n|`500`|Errore generico|\n\n## Descrizione Risposta\n|Proprietà|Descrizione|\n|--- |--- |\n|from|Il mittente del messaggio.|\n|text|Testo Sms|\n|transactionId|identificatore dell'invio<br>Se non specificato in fase di richiesta verrà generato un **transactionId** automaticamente dalle REST API|"
},
"response": [
{
"name": "Invio SMS bulk",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Authorization",
"value": "Basic AAAxxxxxxxxxxxxxxxxxxx",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "transactionCallback",
"value": "",
"description": "[String] *(Opzionale)*\n\nURL al quale sarà inviata via HTTP una notifica con lo stato complessivo dell'invio\n[Gestione notificationCallback](#Gestione-notificationCallback)",
"type": "text",
"disabled": true
},
{
"key": "from",
"value": "www.SmsH.it",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "group",
"value": "gruppo",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "text",
"value": "sms di test",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/sendbulk",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"sendbulk"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [],
"cookie": [],
"body": "{\n \"from\": \"mrossi\",\n \"text\": \"Test Sms\",\n \"transactionId\": \"e51ea840fc7276922ac61b733027301d\"\n}"
}
]
},
{
"name": "Invio SMS Binario",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "text",
"value": "sms di test",
"description": "[String] *(Obbligatorio)*\n\nContenuto binario del messaggio espresso come stringa esadecimale.\nOgni byte deve essere rappresentato con un valore esadecimale di due caratteri.\n\nAd esempio:\n`0fc24abf3413ba`",
"type": "text"
},
{
"key": "udh",
"value": "",
"description": "[String] *(Opzionale)*\nCampo facoltativo contenente l'UDH ([User Data Header](https://en.wikipedia.org/wiki/User_Data_Header)) del messaggio in formato esadecimale.\nAd esempio:\n`00c34abf300311`",
"type": "text",
"disabled": true
},
{
"key": "transactionCallback",
"value": "",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)\n\nURL al quale sarà inviata via HTTP una notifica con lo stato complessivo dell'invio\n[Gestione notificationCallback](#32ddccbd-f896-924a-b9df-7d716a8e4d9d)",
"type": "text",
"disabled": true
},
{
"key": "pid",
"value": "",
"description": "[Number] *(Opzionale)*\nCampo facoltativo contenente l'id protocollo ([Protocol identifier](https://en.wikipedia.org/wiki/GSM_03.40#Protocol_Identifier)) da utilizzare in formato decimale.",
"type": "text",
"disabled": true
},
{
"key": "from",
"value": "www.SmsH.it",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "group",
"value": "gruppo",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/sendbulk",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"sendbulk"
]
},
"description": "Invio di un SMS con contenuto binario.\n\n_Note sulle lunghezza del messaggio_:\n\nLa lunghezza massima di un singolo SMS binario è di **140 byte** (**280 caratteri** espressi in formato esadecimale).\n\nSpecificando un testo più lungo verranno inviati SMS concatenati. Lo spazio a disposizione per gli SMS concatenati è di **134 byte** per SMS (**268 caratteri** espressi in formato esadecimale)\n\n> _Il \"**Content-Type**\" per questa richiesta POST deve essere \"**application/x-www-form-urlencoded**\"_\n\n## HTTP Status Codes\n\n|Codice|Descrizione|\n|--- |--- |\n|`200`|ok|\n|`400`|Parametri non validi<br>I possibili errorMsg sono:<br>`BAD_TRANSACTIONID` - parametro **transactionId** non valido<br>`BAD_DATE` - formato data differito non valida<br>`BAD_TEXT` - parametro **text** non valido<br>`BAD_CALLBACK` - parametro **statusCallback** non valido<br>`BAD_ENCODING` - parametro **encoding** non valido<br>`BAD_FROM` - parametro **from** non valido<br>`BAD_GROUP` - parametro **group** non valido<br>`BAD_CREDIT` - credito insufficiente per effetturare l'invio<br>`NO_VALID_RECIPIENT` - nessun valido destinatario<br>`BAD_TEXT_HEX` - il testo non contiene un esadecimale valido.<br>`BAD_UDH_HEX` - l'udh non contiene un esadecimale valido.<br>`BAD_PID` - il pid non contiente un valore intero valido<br>`GENERIC_ERROR` - errore interno al server|\n|`401`|Credenziali non valide|\n|`405`|Metodo HTTP non consentito|\n|`500`|Errore generico|\n\n## Descrizione Risposta\nI dati di invio ritornati sono gli stessi della chiamata Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)."
},
"response": [
{
"name": "Invio SMS Binario",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Authorization",
"value": "Basic AAAxxxxxxxxxxxxxxxxxxx",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "transactionCallback",
"value": "",
"description": "[String] *(Opzionale)*\n\nURL al quale sarà inviata via HTTP una notifica con lo stato complessivo dell'invio\n[Gestione notificationCallback](#Gestione-notificationCallback)",
"type": "text",
"disabled": true
},
{
"key": "from",
"value": "www.SmsH.it",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "to",
"value": "393480000000",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "group",
"value": "gruppo",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "text",
"value": "sms di test",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "date",
"value": "2017-03-24T00:00:00+0100",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "sandbox",
"value": "true",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text"
},
{
"key": "statusCallback",
"value": "http://user_callback",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
},
{
"key": "encoding",
"value": "7BIT",
"description": "Vedi [Invio SMS](#2612f319-cc1f-486e-afa7-f434b2f536e3)",
"type": "text",
"disabled": true
}
]
},
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/sendbulk",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"sendbulk"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [],
"cookie": [],
"body": "{\n \"from\": \"mrossi\",\n \"text\": \"0fc24abf3413ba\",\n \"transactionId\": \"e51ea840fc7276922ac61b733027301d\"\n}"
}
]
},
{
"name": "Cerca SMS",
"protocolProfileBehavior": {
"disabledSystemHeaders": {
"accept": true
}
},
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/search?id&transactionId=123456789ABCDE&msisdn&fromDate&toDate&status&offset=0&limit=20",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"search"
],
"query": [
{
"key": "id",
"value": null,
"description": "[String] *(Opzionale [§1](#note))*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**12312** oppure **432432,543543,435435**"
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "[String] *(Opzionale [§1](#note))*\n\n**transactionId** assegnato all'invio."
},
{
"key": "msisdn",
"value": null,
"description": "[String] *(Opzionale [§1](#note))*\n\nNumero al quale è stato inviato il messaggio"
},
{
"key": "fromDate",
"value": null,
"description": "[String] *(Opzionale [§1](#note))*\n\nCerca gli sms stati inviati da questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)\n\nIl carattere **Z** indica il timezone nel formato RFC822 4-digit. \n_Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno_."
},
{
"key": "toDate",
"value": null,
"description": "[String] *(Opzionale)*\n\nCerca gli sms stati inviati fino a questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)"
},
{
"key": "status",
"value": null,
"description": "[String] *(Opzionale [§1](#note))*\n\nStato degli sms [Vedi valori] (#32ddccbd-f896-924a-b9df-7d716a8e4d9d)"
},
{
"key": "offset",
"value": "0",
"description": "[Number] *(Opzionale)*\n\nPosizione del primo risultato che verrà restituito.\n\nEsempio:\nSe la ricerca trova 100 sms, il campo **offset** viene valorizzato a 50 ed il campo **limit** a 10 verranno restituiti gli sms da 51 a 60.\n**Default : 0**"
},
{
"key": "limit",
"value": "20",
"description": "[Number] *(Opzionale)*\n\nNumero di risultati che verranno restituiti.\n**Default: 20**"
}
]
},
"description": "Cerca tra gli SMS inviati.\n\n## HTTP Status Codes\n\n|Codice|Descrizione|\n|--- |--- |\n|`200`|ok|\n|`400`|Parametri non validi<br>I possibili errorMsg sono:<br>`NO_PARAMS` - Nessun parametro valorizzato<br>`BAD_ID` - Parametro id non valido<br>`BAD_MSISDN` - Parametro msisdn non valido<br>`BAD_DATE` - Formato date non valido<br>`BAD_STATUS` - Parametro status non valido|\n|`401`|Credenziali non valide|\n|`405`|Metodo HTTP non consentito|\n|`500`|Errore generico|\n\n## Descrizione Risposta\n\n|Proprietà|Descrizione|\n|--- |--- |\n|`smsList`|Lista degli sms ricevuti<br>Ogni sms è descritto dalle proprietà:<br>`id` - id interno messaggio<br>`to` - destinatario del messaggio<br>`text` - testo del messaggio<br>`from` - mittente del messaggio<br>`status` - stato del messaggio.Vedi la tabella sottostante<br>`insertDate` - data inserimento del messaggio nel formato **yyyy-MM-ddTHH:mm:ssZ**<br>`sentDate` - data invio del messaggio nel formato **yyyy-MM-ddTHH:mm:ssZ**<br>`deliveryDate` - data consegna del messaggio nel formato **yyyy-MM-ddTHH:mm:ssZ**<br>`transactionId` - Identificatore dell'invio<br>`price` - costo del messaggio|\n|`metadata`|Metadata per gestire la [paginazione](#gestire-la-risposta)|"
},
"response": [
{
"name": "Cerca SMS",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Basic AAAxxxxxxxxxxxxxxxxxxx",
"type": "text"
}
],
"url": {
"raw": "{{BaseUrl}}/rest/api/sms/search?id&transactionId=123456789ABCDE&msisdn&fromDate&toDate&status&offset=0&limit=20",
"host": [
"{{BaseUrl}}"
],
"path": [
"rest",
"api",
"sms",
"search"
],
"query": [
{
"key": "id",
"value": null,
"description": "[String] *(Opzionale ¹)*\n\nId interno del messaggio inviato.\n\nÈ possibile specificare **più id** separandoli con il carattere virgola \"**,**\".\n\nAd esempio:\n\n**12312** oppure **432432,543543,435435**"
},
{
"key": "transactionId",
"value": "123456789ABCDE",
"description": "[String] *(Opzionale ¹)*\n\n**transactionId** assegnato all'invio."
},
{
"key": "msisdn",
"value": null,
"description": "[String] *(Opzionale ¹)*\n\nNumero al quale è stato inviato il messaggio"
},
{
"key": "fromDate",
"value": null,
"description": "[String] *(Opzionale ¹)*\nCerca gli sms stati inviati da questa data (formato **yyyy-MM-ddTHH:mm:ssZ**)\nIl carattere **Z** indica il timezone nel formato RFC822 4-digit. _Per l'Italia +0200 durante l'orario estivo e +0100 nel restante periodo dell'anno_."
},
{
"key": "toDate",