{"apiVersion":"1.0","apis":[{"path":"/sms","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"iamTags","dataType":"map[string][]iam.resource.TagFilter","paramType":"query","required":false,"description":"Filter resources on IAM tags"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List SMS accounts","iamActions":[{"name":"sms:apiovh:get","required":true}]}],"description":"Operations about the VOIP service"},{"path":"/sms/estimate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"message","dataType":"text","paramType":"body","fullType":"text","required":true,"description":"The message to send"},{"name":"noStopClause","dataType":"boolean","paramType":"body","fullType":"boolean","required":true,"description":"Do not display STOP clause in the message, this requires that this is not an advertising message"},{"name":"senderType","dataType":"sms.TypeSenderEnum","paramType":"body","fullType":"sms.TypeSenderEnum","required":true,"description":"Sender type that will be used to send the message"}],"responseType":"sms.JobEstimate","responseTypes":{"200":"sms.JobEstimate"},"noAuthentication":false,"description":"Estimate a message","iamActions":[{"name":"account:apiovh:sms/estimate","required":true}]}],"description":"Estimate a message"},{"path":"/sms/ptts","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"ptt","dataType":"long","paramType":"query","fullType":"long","required":true,"description":"The premium transaction tracking code"}],"responseType":"sms.PttDetails","responseTypes":{"200":"sms.PttDetails"},"noAuthentication":false,"description":"Get a PTT code"}],"description":"Get a PTT code"},{"path":"/sms/rates/destinations","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"billingCountry","dataType":"sms.BillingCountryEnum","paramType":"query","fullType":"sms.BillingCountryEnum","required":false,"description":"Country where you buy credits"},{"name":"country","dataType":"sms.CountryEnum","paramType":"query","fullType":"sms.CountryEnum","required":true,"description":"Country where you send SMS"}],"responseType":"sms.DestinationRates","responseTypes":{"200":"sms.DestinationRates"},"noAuthentication":true,"description":"Get rates for a country"}],"description":"Get rates for a country"},{"path":"/sms/rates/packs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"billingCountry","dataType":"sms.BillingCountryEnum","paramType":"query","fullType":"sms.BillingCountryEnum","required":false,"description":"Country where you buy credits"},{"name":"country","dataType":"sms.CountryEnum","paramType":"query","fullType":"sms.CountryEnum","required":true,"description":"Country where you send SMS"}],"responseType":"sms.PackDetails[]","responseTypes":{"200":"sms.PackDetails[]"},"noAuthentication":true,"description":"List SMS pack prices"}],"description":"List SMS pack prices"},{"path":"/sms/virtualNumbers","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"iamTags","dataType":"map[string][]iam.resource.TagFilter","paramType":"query","required":false,"description":"Filter resources on IAM tags"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List virtual numbers","iamActions":[{"name":"smsVirtualNumbers:apiovh:get","required":true}]}],"description":"Operations about the VOIP service"},{"path":"/sms/virtualNumbers/{number}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Your virtual number"}],"responseType":"sms.VirtualNumberGenericServiceWithIAM","responseTypes":{"200":"sms.VirtualNumberGenericServiceWithIAM"},"noAuthentication":false,"description":"Get a virtual number service","iamActions":[{"name":"smsVirtualNumbers:apiovh:get","required":true}]}],"description":"Virtual numbers"},{"path":"/sms/virtualNumbers/{number}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Your virtual number"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get service information","longDescription":"Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.","iamActions":[{"name":"smsVirtualNumbers:apiovh:serviceInfos/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"services.Service","paramType":"body","fullType":"services.Service","required":true,"description":"New object properties"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Your virtual number"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update service information","longDescription":"Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.","iamActions":[{"name":"smsVirtualNumbers:apiovh:serviceInfos/edit","required":true}]}],"description":"Details about a Service"},{"path":"/sms/{serviceName}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.AccountWithIAM","responseTypes":{"200":"sms.AccountWithIAM"},"noAuthentication":false,"description":"Get an SMS account","iamActions":[{"name":"sms:apiovh:get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.Account","paramType":"body","fullType":"sms.Account","required":true,"description":"New object properties"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update an SMS account","iamActions":[{"name":"sms:apiovh:put","required":true}]}],"description":"SMS details"},{"path":"/sms/{serviceName}/batches","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Batch[]","responseTypes":{"200":"sms.Batch[]"},"noAuthentication":false,"description":"List batches","longDescription":"Returns the batches of the SMS account.","iamActions":[{"name":"sms:apiovh:batches/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"dataType":"sms.BatchParams","paramType":"body","fullType":"sms.BatchParams","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Batch","responseTypes":{"200":"sms.Batch"},"noAuthentication":false,"description":"Create a batch","longDescription":"Creates a batch that sends one message to a list of receivers or to a receiver list. Set a sender, or ask for one that allows replies. Sending can be deferred to a later date.","iamActions":[{"name":"sms:apiovh:batches/create","required":true}]}],"description":"Manage SMS batches"},{"path":"/sms/{serviceName}/batches/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a batch","longDescription":"Deletes the batch.","iamActions":[{"name":"sms:apiovh:batches/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Batch","responseTypes":{"200":"sms.Batch"},"noAuthentication":false,"description":"Get a batch","longDescription":"Returns the batch: message, sender, receivers, status, estimated credits and errors.","iamActions":[{"name":"sms:apiovh:batches/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.BatchUpdateParams","paramType":"body","fullType":"sms.BatchUpdateParams","required":true,"description":"Request Body"},{"name":"id","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Batch","responseTypes":{"200":"sms.Batch"},"noAuthentication":false,"description":"Update a batch","longDescription":"Updates the batch name.","iamActions":[{"name":"sms:apiovh:batches/edit","required":true}]}],"description":"Manage SMS batches"},{"path":"/sms/{serviceName}/batches/{id}/cancel","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"id","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Batch","responseTypes":{"200":"sms.Batch"},"noAuthentication":false,"description":"Cancel a deferred batch","longDescription":"Cancels a batch scheduled for later. Only possible if no SMS of the batch has been sent yet.","iamActions":[{"name":"sms:apiovh:batches/cancel","required":true}]}],"description":""},{"path":"/sms/{serviceName}/batches/{id}/statistics","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.BatchStatistics","responseTypes":{"200":"sms.BatchStatistics"},"noAuthentication":false,"description":"Get batch statistics","longDescription":"Returns the batch statistics: delivered, sent, pending, failed and stoplisted SMS, and the credits used.","iamActions":[{"name":"sms:apiovh:batches/statistics/get","required":true}]}],"description":""},{"path":"/sms/{serviceName}/blacklists","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"batchID","dataType":"uuid","paramType":"query","fullType":"uuid","required":false,"description":"Filter the value of batchID property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"smsOutgoingID","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter the value of smsOutgoingID property (=)"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List blacklisted numbers","iamActions":[{"name":"sms:apiovh:blacklists/get","required":true}]}],"description":"List the sms.Blacklist objects"},{"path":"/sms/{serviceName}/blacklists/{number}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms number blacklisted"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a blacklisted number","iamActions":[{"name":"sms:apiovh:blacklists/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms number blacklisted"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Blacklist","responseTypes":{"200":"sms.Blacklist"},"noAuthentication":false,"description":"Get a blacklisted number","iamActions":[{"name":"sms:apiovh:blacklists/get","required":true}]}],"description":"SMS blacklist"},{"path":"/sms/{serviceName}/document","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"batchID","dataType":"uuid","paramType":"query","fullType":"uuid","required":false,"description":"Filter SMSs with their batch ID (outgoing SMSs only)"},{"name":"creationDatetime.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (>=)"},{"name":"creationDatetime.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (<=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Select sms with a specific identifier group tag"},{"name":"wayType","dataType":"sms.DocumentWayTypeEnum","paramType":"query","fullType":"sms.DocumentWayTypeEnum","required":true,"description":"specify outgoing or incoming sms"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Export SMS to a document","iamActions":[{"name":"sms:apiovh:document/get","required":true}]}],"description":"document operations"},{"path":"/sms/{serviceName}/exceptions","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"receiver","dataType":"string","paramType":"query","fullType":"string","required":true,"description":"The receiver number to check"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Exception[]","responseTypes":{"200":"sms.Exception[]"},"noAuthentication":false,"description":"List sending restrictions for a number","iamActions":[{"name":"sms:apiovh:exceptions/get","required":true}]}],"description":"exceptions operations"},{"path":"/sms/{serviceName}/hlr","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List HLR lookups","iamActions":[{"name":"sms:apiovh:hlr/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"receivers","dataType":"string[]","paramType":"body","fullType":"string[]","required":false,"description":"The receivers"},{"name":"receiversDocumentUrl","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The receivers document url link in csv format"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.SmsSendingReport","responseTypes":{"200":"sms.SmsSendingReport"},"noAuthentication":false,"description":"Request HLR lookups","iamActions":[{"name":"sms:apiovh:hlr/create","required":true}]}],"description":"List the sms.HlrLookupNumber objects"},{"path":"/sms/{serviceName}/hlr/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"HLR id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.HlrLookupNumber","responseTypes":{"200":"sms.HlrLookupNumber"},"noAuthentication":false,"description":"Get an HLR lookup","iamActions":[{"name":"sms:apiovh:hlr/get","required":true}]}],"description":"Home Location Register informations. Give informations about a given cellular phone."},{"path":"/sms/{serviceName}/hlr/{id}/operator","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"HLR id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Hlr","responseTypes":{"200":"sms.Hlr"},"noAuthentication":false,"description":"Get the receiver operator","iamActions":[{"name":"sms:apiovh:hlr/operator/get","required":true}]}],"description":"Sms operator informations"},{"path":"/sms/{serviceName}/incoming","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDatetime.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (>=)"},{"name":"creationDatetime.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (<=)"},{"name":"sender","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of sender property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of tag property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List received SMS","iamActions":[{"name":"sms:apiovh:incoming/get","required":true}]}],"description":"List the sms.Incoming objects"},{"path":"/sms/{serviceName}/incoming/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a received SMS","iamActions":[{"name":"sms:apiovh:incoming/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Incoming","responseTypes":{"200":"sms.Incoming"},"noAuthentication":false,"description":"Get a received SMS","iamActions":[{"name":"sms:apiovh:incoming/get","required":true}]}],"description":"Sms history of sms incoming received"},{"path":"/sms/{serviceName}/jobs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List pending jobs","iamActions":[{"name":"sms:apiovh:jobs/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"charset","dataType":"sms.CharsetEnum","paramType":"body","fullType":"sms.CharsetEnum","required":false,"description":"The sms coding"},{"name":"class","dataType":"sms.ClassEnum","paramType":"body","fullType":"sms.ClassEnum","required":false,"description":"Deprecated: The sms class"},{"name":"coding","dataType":"sms.CodingEnum","paramType":"body","fullType":"sms.CodingEnum","required":false,"description":"Deprecated: the coding is deduced from the message and its charset"},{"name":"differedPeriod","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"The time -in minute(s)- to wait before sending the message"},{"name":"message","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The sms message"},{"name":"noStopClause","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Do not display STOP clause in the message, this requires that this is not an advertising message"},{"name":"priority","dataType":"sms.PriorityEnum","paramType":"body","fullType":"sms.PriorityEnum","required":false,"description":"The priority of the message"},{"name":"receivers","dataType":"string[]","paramType":"body","fullType":"string[]","required":false,"description":"The receivers list"},{"name":"receiversDocumentUrl","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The receivers document url link in csv format"},{"name":"receiversSlotId","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The receivers document slot id"},{"name":"sender","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The sender"},{"name":"senderForResponse","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Set the flag to send a special sms which can be reply by the receiver (smsResponse)."},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The identifier group tag"},{"name":"validityPeriod","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"The maximum time -in minute(s)- before the message is dropped"}],"responseType":"sms.SmsSendingReportUser","responseTypes":{"200":"sms.SmsSendingReportUser"},"noAuthentication":false,"description":"Send SMS","iamActions":[{"name":"sms:apiovh:jobs/create","required":true}]}],"description":"List the sms.Job objects"},{"path":"/sms/{serviceName}/jobs/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a pending job","iamActions":[{"name":"sms:apiovh:jobs/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Job","responseTypes":{"200":"sms.Job"},"noAuthentication":false,"description":"Get a pending job","iamActions":[{"name":"sms:apiovh:jobs/get","required":true}]}],"description":"Sms job"},{"path":"/sms/{serviceName}/outgoing","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"batchID","dataType":"uuid","paramType":"query","fullType":"uuid","required":false,"description":"Filter on batch id property (=)"},{"name":"creationDatetime.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter on creationDatetime property (>=)"},{"name":"creationDatetime.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter on creationDatetime property (<=)"},{"name":"deliveryReceipt","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter on deliveryReceipt property (=)"},{"name":"differedDelivery","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter on differedDelivery property (=)"},{"name":"messageID","dataType":"uuid","paramType":"query","fullType":"uuid","required":false,"description":"Filter on message id property (=)"},{"name":"ptt","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter on ptt property (=)"},{"name":"receiver","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter on receiver property (=)"},{"name":"sender","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter on sender property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter on tag property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List sent SMS","longDescription":"Returns the identifiers of the SMS sent from the account.","iamActions":[{"name":"sms:apiovh:outgoing/get","required":true}]}],"description":"Sent SMSs associated to SMS account"},{"path":"/sms/{serviceName}/outgoing/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a sent SMS","longDescription":"Deletes the sent SMS from the history.","iamActions":[{"name":"sms:apiovh:outgoing/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Outgoing","responseTypes":{"200":"sms.Outgoing"},"noAuthentication":false,"description":"Get a sent SMS","longDescription":"Returns the sent SMS: receiver, message, delivery status, number of SMS parts and credits used.","iamActions":[{"name":"sms:apiovh:outgoing/get","required":true}]}],"description":"Sent SMSs associated to SMS account"},{"path":"/sms/{serviceName}/outgoing/{id}/hlr","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Hlr","responseTypes":{"200":"sms.Hlr"},"noAuthentication":false,"description":"Get the receiver operator","iamActions":[{"name":"sms:apiovh:outgoing/hlr/get","required":true}]}],"description":"Sms operator informations"},{"path":"/sms/{serviceName}/phonebooks","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List phonebooks","iamActions":[{"name":"sms:apiovh:phonebooks/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"name","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Name of the wanted phonebook"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Create a phonebook","iamActions":[{"name":"sms:apiovh:phonebooks/create","required":true}]}],"description":"List the sms.Phonebook objects"},{"path":"/sms/{serviceName}/phonebooks/{bookKey}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a phonebook","iamActions":[{"name":"sms:apiovh:phonebooks/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Phonebook","responseTypes":{"200":"sms.Phonebook"},"noAuthentication":false,"description":"Get a phonebook","iamActions":[{"name":"sms:apiovh:phonebooks/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.Phonebook","paramType":"body","fullType":"sms.Phonebook","required":true,"description":"New object properties"},{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a phonebook","iamActions":[{"name":"sms:apiovh:phonebooks/edit","required":true}]}],"description":"Phone book"},{"path":"/sms/{serviceName}/phonebooks/{bookKey}/export","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"format","dataType":"telephony.ContactsExportFormatsEnum","paramType":"query","fullType":"telephony.ContactsExportFormatsEnum","required":true,"description":"Format of the file"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"telephony.PcsFile","responseTypes":{"200":"telephony.PcsFile"},"noAuthentication":false,"description":"Export contacts","iamActions":[{"name":"sms:apiovh:phonebooks/export/get","required":true}]}],"description":"export operations"},{"path":"/sms/{serviceName}/phonebooks/{bookKey}/import","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"documentId","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"ID of the /me/document file you want to import"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"telephony.Task","responseTypes":{"200":"telephony.Task"},"noAuthentication":false,"description":"Import contacts","iamActions":[{"name":"sms:apiovh:phonebooks/import","required":true}]}],"description":"import operations"},{"path":"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List contacts","iamActions":[{"name":"sms:apiovh:phonebooks/phonebookContact/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"group","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Group name of the phonebook"},{"name":"homeMobile","dataType":"internationalPhoneNumber","paramType":"body","fullType":"internationalPhoneNumber","required":false,"description":"Home mobile phone number of the contact"},{"name":"homePhone","dataType":"internationalPhoneNumber","paramType":"body","fullType":"internationalPhoneNumber","required":false,"description":"Home landline phone number of the contact"},{"name":"name","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Name of the contact"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"surname","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Contact surname"},{"name":"workMobile","dataType":"internationalPhoneNumber","paramType":"body","fullType":"internationalPhoneNumber","required":false,"description":"Mobile phone office number of the contact"},{"name":"workPhone","dataType":"internationalPhoneNumber","paramType":"body","fullType":"internationalPhoneNumber","required":false,"description":"Landline phone office number of the contact"}],"responseType":"long","responseTypes":{"200":"long"},"noAuthentication":false,"description":"Create a contact","iamActions":[{"name":"sms:apiovh:phonebooks/phonebookContact/create","required":true}]}],"description":"List the sms.PhonebookContact objects"},{"path":"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Contact identifier"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a contact","iamActions":[{"name":"sms:apiovh:phonebooks/phonebookContact/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Contact identifier"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.PhonebookContact","responseTypes":{"200":"sms.PhonebookContact"},"noAuthentication":false,"description":"Get a contact","iamActions":[{"name":"sms:apiovh:phonebooks/phonebookContact/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.PhonebookContact","paramType":"body","fullType":"sms.PhonebookContact","required":true,"description":"New object properties"},{"name":"bookKey","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Identifier of the phonebook"},{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Contact identifier"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a contact","iamActions":[{"name":"sms:apiovh:phonebooks/phonebookContact/edit","required":true}]}],"description":"Phone book contact"},{"path":"/sms/{serviceName}/receivers","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List receiver lists","iamActions":[{"name":"sms:apiovh:receivers/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"autoUpdate","dataType":"boolean","paramType":"body","fullType":"boolean","required":true,"description":"Download file from URL before sending to contacts (works only with csvUrl and not document ID)"},{"name":"csvUrl","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"URL of the file you want to import"},{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Description name of the document"},{"name":"documentId","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"ID of the /me/document file you want to import"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"body","fullType":"long","required":true,"description":"Slot number id used to handle the document"}],"responseType":"sms.Receiver","responseTypes":{"200":"sms.Receiver"},"noAuthentication":false,"description":"Create a receiver list","iamActions":[{"name":"sms:apiovh:receivers/create","required":true}]}],"description":"List the sms.Receiver objects"},{"path":"/sms/{serviceName}/receivers/{slotId}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a receiver list","iamActions":[{"name":"sms:apiovh:receivers/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"sms.Receiver","responseTypes":{"200":"sms.Receiver"},"noAuthentication":false,"description":"Get a receiver list","iamActions":[{"name":"sms:apiovh:receivers/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.Receiver","paramType":"body","fullType":"sms.Receiver","required":true,"description":"New object properties"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a receiver list","iamActions":[{"name":"sms:apiovh:receivers/edit","required":true}]}],"description":"Sms receivers preloaded"},{"path":"/sms/{serviceName}/receivers/{slotId}/clean","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"freemium","dataType":"boolean","paramType":"body","fullType":"boolean","required":true,"description":"Limit checks to syntaxical validation"},{"name":"priceOnly","dataType":"boolean","paramType":"body","fullType":"boolean","required":true,"description":"Only get action's price in credits without executing it"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"sms.ReceiversAsynchronousCleanReport","responseTypes":{"200":"sms.ReceiversAsynchronousCleanReport"},"noAuthentication":false,"description":"Clean a receiver list","iamActions":[{"name":"sms:apiovh:receivers/clean","required":true}]}],"description":"clean operations"},{"path":"/sms/{serviceName}/receivers/{slotId}/csv","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Get the receiver list CSV","iamActions":[{"name":"sms:apiovh:receivers/csv/get","required":true}]}],"description":"csv operations"},{"path":"/sms/{serviceName}/seeOffers","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"countryCurrencyPrice","dataType":"reference.CountryEnum","paramType":"query","fullType":"reference.CountryEnum","required":true,"description":"Filter to have the currency country prices"},{"name":"countryDestination","dataType":"sms.CountryEnum","paramType":"query","fullType":"sms.CountryEnum","required":true,"description":"Filter to have the country destination"},{"name":"quantity","dataType":"sms.PackQuantityEnum","paramType":"query","fullType":"sms.PackQuantityEnum","required":true,"description":"Sms pack offer quantity"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.PackOffer[]","responseTypes":{"200":"sms.PackOffer[]"},"noAuthentication":false,"description":"List SMS offers","iamActions":[{"name":"sms:apiovh:seeOffers/get","required":true}]}],"description":"seeOffers operations"},{"path":"/sms/{serviceName}/senders","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List senders","iamActions":[{"name":"sms:apiovh:senders/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"Sender description"},{"name":"reason","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"Message seen by the moderator"},{"name":"sender","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The sender (alpha or phone number)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Create a sender","iamActions":[{"name":"sms:apiovh:senders/create","required":true}]}],"description":"List the sms.Sender objects"},{"path":"/sms/{serviceName}/senders/{sender}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a sender","iamActions":[{"name":"sms:apiovh:senders/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Sender","responseTypes":{"200":"sms.Sender"},"noAuthentication":false,"description":"Get a sender","iamActions":[{"name":"sms:apiovh:senders/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.Sender","paramType":"body","fullType":"sms.Sender","required":true,"description":"New object properties"},{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a sender","iamActions":[{"name":"sms:apiovh:senders/edit","required":true}]}],"description":"SMS senders"},{"path":"/sms/{serviceName}/senders/{sender}/documents","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"uuid[]","responseTypes":{"200":"uuid[]"},"noAuthentication":false,"description":"List validation documents","iamActions":[{"name":"sms:apiovh:senders/documents/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"Document description"},{"name":"name","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Document name"},{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.SenderDocument","responseTypes":{"200":"sms.SenderDocument"},"noAuthentication":false,"description":"Create a validation document","iamActions":[{"name":"sms:apiovh:senders/documents/create","required":true}]}],"description":"List the sms.SenderDocument objects"},{"path":"/sms/{serviceName}/senders/{sender}/documents/{documentID}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"documentID","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Document ID"},{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.SenderDocument","responseTypes":{"200":"sms.SenderDocument"},"noAuthentication":false,"description":"Get a validation document","iamActions":[{"name":"sms:apiovh:senders/documents/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.SenderDocument","paramType":"body","fullType":"sms.SenderDocument","required":true,"description":"New object properties"},{"name":"documentID","dataType":"uuid","paramType":"path","fullType":"uuid","required":true,"description":"Document ID"},{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a validation document","iamActions":[{"name":"sms:apiovh:senders/documents/edit","required":true}]}],"description":"SMS senders' document"},{"path":"/sms/{serviceName}/senders/{sender}/validate","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"code","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The validation code"},{"name":"sender","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms sender"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Validate a sender","iamActions":[{"name":"sms:apiovh:senders/validate","required":true}]}],"description":"validate operations"},{"path":"/sms/{serviceName}/sendersAvailableForValidation","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"referer","dataType":"sms.SenderRefererEnum","paramType":"query","fullType":"sms.SenderRefererEnum","required":false,"description":"Information type"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.SenderAvailable[]","responseTypes":{"200":"sms.SenderAvailable[]"},"noAuthentication":false,"description":"List senders available for validation","iamActions":[{"name":"sms:apiovh:sendersAvailableForValidation/get","required":true}]}],"description":"sendersAvailableForValidation operations"},{"path":"/sms/{serviceName}/serviceInfos","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"services.Service","responseTypes":{"200":"services.Service"},"noAuthentication":false,"description":"Get service information","longDescription":"Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.","iamActions":[{"name":"sms:apiovh:serviceInfos/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"services.Service","paramType":"body","fullType":"services.Service","required":true,"description":"New object properties"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update service information","longDescription":"Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.","iamActions":[{"name":"sms:apiovh:serviceInfos/edit","required":true}]}],"description":"Details about a Service"},{"path":"/sms/{serviceName}/smpp/allowedIPs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"ip[]","responseTypes":{"200":"ip[]"},"noAuthentication":false,"description":"List SMPP allowed IPs","longDescription":"Returns the IP addresses allowed to connect to the SMPP account.","iamActions":[{"name":"sms:apiovh:smpp/allowedIPs/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.AllowedIPs","paramType":"body","fullType":"sms.AllowedIPs","required":true,"description":"Request Body"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"ip[]","responseTypes":{"200":"ip[]"},"noAuthentication":false,"description":"Add or remove SMPP allowed IPs","longDescription":"Adds or removes IP addresses allowed to connect to the SMPP account, depending on the action.","iamActions":[{"name":"sms:apiovh:smpp/allowedIPs/edit","required":true}]}],"description":"Manage smpp allowedIPs"},{"path":"/sms/{serviceName}/smpp/password","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Renew the SMPP password","longDescription":"Generates a new password for the SMPP account.","iamActions":[{"name":"sms:apiovh:smpp/password/create","required":true}]}],"description":"Manage SMPP password"},{"path":"/sms/{serviceName}/smpp/settings","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Settings","responseTypes":{"200":"sms.Settings"},"noAuthentication":false,"description":"Get the SMPP settings","longDescription":"Returns the SMPP settings: TLS and non-TLS endpoints, system ID, status, throughput and windowing.","iamActions":[{"name":"sms:apiovh:smpp/settings/get","required":true}]}],"description":"Get SMPP settings"},{"path":"/sms/{serviceName}/task","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"status","dataType":"telephony.TaskStatusEnum","paramType":"query","fullType":"telephony.TaskStatusEnum","required":false,"description":"Filter the value of status property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List tasks","iamActions":[{"name":"sms:apiovh:task/get","required":true}]}],"description":"List the sms.Task objects"},{"path":"/sms/{serviceName}/task/{taskId}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"taskId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":""}],"responseType":"sms.Task","responseTypes":{"200":"sms.Task"},"noAuthentication":false,"description":"Get a task","iamActions":[{"name":"sms:apiovh:task/get","required":true}]}],"description":"Operation on a SMS service"},{"path":"/sms/{serviceName}/templatesControl","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List message templates","iamActions":[{"name":"sms:apiovh:templatesControl/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"activity","dataType":"sms.TypeTemplateEnum","paramType":"body","fullType":"sms.TypeTemplateEnum","required":true,"description":"Specify the kind of template"},{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"Template description"},{"name":"message","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area."},{"name":"name","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Name of the template"},{"name":"reason","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"Message seen by the moderator"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Create a message template","iamActions":[{"name":"sms:apiovh:templatesControl/create","required":true}]}],"description":"List the sms.TemplateControl objects"},{"path":"/sms/{serviceName}/templatesControl/{name}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name of the template"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a message template","iamActions":[{"name":"sms:apiovh:templatesControl/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name of the template"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.TemplateControl","responseTypes":{"200":"sms.TemplateControl"},"noAuthentication":false,"description":"Get a message template","iamActions":[{"name":"sms:apiovh:templatesControl/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.TemplateControl","paramType":"body","fullType":"sms.TemplateControl","required":true,"description":"New object properties"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name of the template"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a message template","iamActions":[{"name":"sms:apiovh:templatesControl/edit","required":true}]}],"description":"Sms template for moderation (Needed to send in US country)"},{"path":"/sms/{serviceName}/templatesControl/{name}/relaunchValidation","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Template description"},{"name":"message","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area"},{"name":"name","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"Name of the template"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Relaunch template validation","iamActions":[{"name":"sms:apiovh:templatesControl/relaunchValidation","required":true}]}],"description":"relaunchValidation operations"},{"path":"/sms/{serviceName}/transferCredits","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"credits","dataType":"double","paramType":"body","fullType":"double","required":true,"description":"Amount of credits to transfer."},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"smsAccountTarget","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Sms account destination."}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Transfer credits","iamActions":[{"name":"sms:apiovh:transferCredits","required":true}]}],"description":"transferCredits operations"},{"path":"/sms/{serviceName}/users","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List users","iamActions":[{"name":"sms:apiovh:users/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"login","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The sms login"},{"name":"password","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The sms password"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Create a user","iamActions":[{"name":"sms:apiovh:users/create","required":true}]}],"description":"List the sms.User objects"},{"path":"/sms/{serviceName}/users/{login}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a user","iamActions":[{"name":"sms:apiovh:users/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.User","responseTypes":{"200":"sms.User"},"noAuthentication":false,"description":"Get a user","iamActions":[{"name":"sms:apiovh:users/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.User","paramType":"body","fullType":"sms.User","required":true,"description":"New object properties"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a user","iamActions":[{"name":"sms:apiovh:users/edit","required":true}]}],"description":"SMS users"},{"path":"/sms/{serviceName}/users/{login}/document","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDatetime.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (>=)"},{"name":"creationDatetime.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (<=)"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Select sms with a specific identifier group tag"},{"name":"wayType","dataType":"sms.DocumentWayTypeEnum","paramType":"query","fullType":"sms.DocumentWayTypeEnum","required":true,"description":"specify outgoing or incoming sms"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Export SMS to a document","iamActions":[{"name":"sms:apiovh:users/document/get","required":true}]}],"description":"document operations"},{"path":"/sms/{serviceName}/users/{login}/incoming","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"sender","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of sender property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of tag property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List received SMS","iamActions":[{"name":"sms:apiovh:users/incoming/get","required":true}]}],"description":"List the sms.Incoming objects"},{"path":"/sms/{serviceName}/users/{login}/incoming/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a received SMS","iamActions":[{"name":"sms:apiovh:users/incoming/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Incoming","responseTypes":{"200":"sms.Incoming"},"noAuthentication":false,"description":"Get a received SMS","iamActions":[{"name":"sms:apiovh:users/incoming/get","required":true}]}],"description":"Sms history of sms incoming received"},{"path":"/sms/{serviceName}/users/{login}/jobs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List pending jobs","iamActions":[{"name":"sms:apiovh:users/jobs/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"charset","dataType":"sms.CharsetEnum","paramType":"body","fullType":"sms.CharsetEnum","required":false,"description":"The sms coding"},{"name":"class","dataType":"sms.ClassEnum","paramType":"body","fullType":"sms.ClassEnum","required":false,"description":"Deprecated: The sms class"},{"name":"coding","dataType":"sms.CodingEnum","paramType":"body","fullType":"sms.CodingEnum","required":false,"description":"Deprecated: the coding is deduced from the message and its charset"},{"name":"differedPeriod","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"The time -in minute(s)- to wait before sending the message"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"message","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The sms message"},{"name":"noStopClause","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Do not display STOP clause in the message, this requires that this is not an advertising message"},{"name":"priority","dataType":"sms.PriorityEnum","paramType":"body","fullType":"sms.PriorityEnum","required":false,"description":"The priority of the message"},{"name":"receivers","dataType":"string[]","paramType":"body","fullType":"string[]","required":false,"description":"The receivers list"},{"name":"receiversDocumentUrl","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The receivers document url link in csv format"},{"name":"receiversSlotId","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The receivers document slot id"},{"name":"sender","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The sender"},{"name":"senderForResponse","dataType":"boolean","paramType":"body","fullType":"boolean","required":false,"description":"Set the flag to send a special sms which can be reply by the receiver (smsResponse)."},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The identifier group tag"},{"name":"validityPeriod","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"The maximum time -in minute(s)- before the message is dropped"}],"responseType":"sms.SmsSendingReportUser","responseTypes":{"200":"sms.SmsSendingReportUser"},"noAuthentication":false,"description":"Send SMS","iamActions":[{"name":"sms:apiovh:users/jobs/create","required":true}]}],"description":"List the sms.Job objects"},{"path":"/sms/{serviceName}/users/{login}/jobs/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a pending job","iamActions":[{"name":"sms:apiovh:users/jobs/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Job","responseTypes":{"200":"sms.Job"},"noAuthentication":false,"description":"Get a pending job","iamActions":[{"name":"sms:apiovh:users/jobs/get","required":true}]}],"description":"Sms job"},{"path":"/sms/{serviceName}/users/{login}/outgoing","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"deliveryReceipt","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter the value of deliveryReceipt property (=)"},{"name":"differedDelivery","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter the value of differedDelivery property (=)"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"ptt","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter the value of ptt property (=)"},{"name":"receiver","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of receiver property (=)"},{"name":"sender","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of sender property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of tag property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List sent SMS","iamActions":[{"name":"sms:apiovh:users/outgoing/get","required":true}]}],"description":"List the sms.Outgoing objects"},{"path":"/sms/{serviceName}/users/{login}/outgoing/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a sent SMS","iamActions":[{"name":"sms:apiovh:users/outgoing/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Outgoing","responseTypes":{"200":"sms.Outgoing"},"noAuthentication":false,"description":"Get a sent SMS","iamActions":[{"name":"sms:apiovh:users/outgoing/get","required":true}]}],"description":"Sms history of sms outgoing sent"},{"path":"/sms/{serviceName}/users/{login}/outgoing/{id}/hlr","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Hlr","responseTypes":{"200":"sms.Hlr"},"noAuthentication":false,"description":"Get the receiver operator","iamActions":[{"name":"sms:apiovh:users/outgoing/hlr/get","required":true}]}],"description":"Sms operator informations"},{"path":"/sms/{serviceName}/users/{login}/receivers","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List receiver lists","iamActions":[{"name":"sms:apiovh:users/receivers/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"autoUpdate","dataType":"boolean","paramType":"body","fullType":"boolean","required":true,"description":"Download file from URL before sending to contacts (works only with csvUrl and not document ID)"},{"name":"csvUrl","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"URL of the file you want to import"},{"name":"description","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"Description name of the document"},{"name":"documentId","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"ID of the /me/document file you want to import"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"body","fullType":"long","required":true,"description":"Slot number id used to handle the document"}],"responseType":"sms.Receiver","responseTypes":{"200":"sms.Receiver"},"noAuthentication":false,"description":"Create a receiver list","iamActions":[{"name":"sms:apiovh:users/receivers/create","required":true}]}],"description":"List the sms.Receiver objects"},{"path":"/sms/{serviceName}/users/{login}/receivers/{slotId}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a receiver list","iamActions":[{"name":"sms:apiovh:users/receivers/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"sms.Receiver","responseTypes":{"200":"sms.Receiver"},"noAuthentication":false,"description":"Get a receiver list","iamActions":[{"name":"sms:apiovh:users/receivers/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"PUT","parameters":[{"dataType":"sms.Receiver","paramType":"body","fullType":"sms.Receiver","required":true,"description":"New object properties"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Update a receiver list","iamActions":[{"name":"sms:apiovh:users/receivers/edit","required":true}]}],"description":"Sms receivers preloaded"},{"path":"/sms/{serviceName}/users/{login}/receivers/{slotId}/clean","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"freemium","dataType":"boolean","paramType":"body","fullType":"boolean","required":true,"description":"Limit checks to syntaxical validation"},{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"priceOnly","dataType":"boolean","paramType":"body","fullType":"boolean","required":true,"description":"Only get action's price in credits without executing it"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"sms.ReceiversAsynchronousCleanReport","responseTypes":{"200":"sms.ReceiversAsynchronousCleanReport"},"noAuthentication":false,"description":"Clean a receiver list","iamActions":[{"name":"sms:apiovh:users/receivers/clean","required":true}]}],"description":"clean operations"},{"path":"/sms/{serviceName}/users/{login}/receivers/{slotId}/csv","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"login","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The sms user login"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"slotId","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Slot number id"}],"responseType":"string","responseTypes":{"200":"string"},"noAuthentication":false,"description":"Get the receiver list CSV","iamActions":[{"name":"sms:apiovh:users/receivers/csv/get","required":true}]}],"description":"csv operations"},{"path":"/sms/{serviceName}/virtualNumbers","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"string[]","responseTypes":{"200":"string[]"},"noAuthentication":false,"description":"List virtual numbers","iamActions":[{"name":"sms:apiovh:virtualNumbers/get","required":true}]}],"description":"List the sms.VirtualNumber objects"},{"path":"/sms/{serviceName}/virtualNumbers/{number}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.VirtualNumber","responseTypes":{"200":"sms.VirtualNumber"},"noAuthentication":false,"description":"Get a virtual number","iamActions":[{"name":"sms:apiovh:virtualNumbers/get","required":true}]}],"description":"Virtual numbers"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/chatAccess","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete the web access","iamActions":[{"name":"sms:apiovh:virtualNumbers/chatAccess/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.ChatAccess","responseTypes":{"200":"sms.ChatAccess"},"noAuthentication":false,"description":"Get the web access","iamActions":[{"name":"sms:apiovh:virtualNumbers/chatAccess/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.ChatAccess","responseTypes":{"200":"sms.ChatAccess"},"noAuthentication":false,"description":"Create the web access","iamActions":[{"name":"sms:apiovh:virtualNumbers/chatAccess/create","required":true}]}],"description":"The web access for your virtual number chat application"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/incoming","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDatetime.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (>=)"},{"name":"creationDatetime.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (<=)"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"sender","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of sender property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of tag property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List received SMS","iamActions":[{"name":"sms:apiovh:virtualNumbers/incoming/get","required":true}]}],"description":"List the sms.Incoming objects"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/incoming/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a received SMS","iamActions":[{"name":"sms:apiovh:virtualNumbers/incoming/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Incoming","responseTypes":{"200":"sms.Incoming"},"noAuthentication":false,"description":"Get a received SMS","iamActions":[{"name":"sms:apiovh:virtualNumbers/incoming/get","required":true}]}],"description":"Sms history of sms incoming received"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/jobs","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List pending jobs","iamActions":[{"name":"sms:apiovh:virtualNumbers/jobs/get","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"POST","parameters":[{"name":"charset","dataType":"sms.CharsetEnum","paramType":"body","fullType":"sms.CharsetEnum","required":false,"description":"The sms coding"},{"name":"class","dataType":"sms.ClassEnum","paramType":"body","fullType":"sms.ClassEnum","required":false,"description":"Deprecated: The sms class"},{"name":"coding","dataType":"sms.CodingEnum","paramType":"body","fullType":"sms.CodingEnum","required":false,"description":"Deprecated: the coding is deduced from the message and its charset"},{"name":"differedPeriod","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"The time -in minute(s)- to wait before sending the message"},{"name":"message","dataType":"string","paramType":"body","fullType":"string","required":true,"description":"The sms message"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"priority","dataType":"sms.PriorityEnum","paramType":"body","fullType":"sms.PriorityEnum","required":false,"description":"The priority of the message"},{"name":"receivers","dataType":"string[]","paramType":"body","fullType":"string[]","required":false,"description":"The receivers list"},{"name":"receiversDocumentUrl","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The receivers document url link in csv format"},{"name":"receiversSlotId","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The receivers document slot id"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"body","fullType":"string","required":false,"description":"The identifier group tag"},{"name":"validityPeriod","dataType":"long","paramType":"body","fullType":"long","required":false,"description":"The maximum time -in minute(s)- before the message is dropped"}],"responseType":"sms.SmsSendingReport","responseTypes":{"200":"sms.SmsSendingReport"},"noAuthentication":false,"description":"Send SMS","iamActions":[{"name":"sms:apiovh:virtualNumbers/jobs/create","required":true}]}],"description":"List the sms.VirtualNumberJob objects"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/jobs/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a pending job","iamActions":[{"name":"sms:apiovh:virtualNumbers/jobs/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.VirtualNumberJob","responseTypes":{"200":"sms.VirtualNumberJob"},"noAuthentication":false,"description":"Get a pending job","iamActions":[{"name":"sms:apiovh:virtualNumbers/jobs/get","required":true}]}],"description":"Sms job"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/outgoing","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"creationDatetime.from","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (>=)"},{"name":"creationDatetime.to","dataType":"datetime","paramType":"query","fullType":"datetime","required":false,"description":"Filter the value of creationDatetime property (<=)"},{"name":"deliveryReceipt","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter the value of deliveryReceipt property (=)"},{"name":"differedDelivery","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter the value of differedDelivery property (=)"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"ptt","dataType":"long","paramType":"query","fullType":"long","required":false,"description":"Filter the value of ptt property (=)"},{"name":"receiver","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of receiver property (=)"},{"name":"sender","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of sender property (=)"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"},{"name":"tag","dataType":"string","paramType":"query","fullType":"string","required":false,"description":"Filter the value of tag property (=)"}],"responseType":"long[]","responseTypes":{"200":"long[]"},"noAuthentication":false,"description":"List sent SMS","iamActions":[{"name":"sms:apiovh:virtualNumbers/outgoing/get","required":true}]}],"description":"List the sms.Outgoing objects"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{id}","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"DELETE","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"void","responseTypes":{"200":"void"},"noAuthentication":false,"description":"Delete a sent SMS","iamActions":[{"name":"sms:apiovh:virtualNumbers/outgoing/delete","required":true}]},{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Outgoing","responseTypes":{"200":"sms.Outgoing"},"noAuthentication":false,"description":"Get a sent SMS","iamActions":[{"name":"sms:apiovh:virtualNumbers/outgoing/get","required":true}]}],"description":"Sms history of sms outgoing sent"},{"path":"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{id}/hlr","operations":[{"apiStatus":{"description":"Stable production version","value":"PRODUCTION"},"httpMethod":"GET","parameters":[{"name":"id","dataType":"long","paramType":"path","fullType":"long","required":true,"description":"Id of the object"},{"name":"number","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The virtual number"},{"name":"serviceName","dataType":"string","paramType":"path","fullType":"string","required":true,"description":"The internal name of your SMS offer"}],"responseType":"sms.Hlr","responseTypes":{"200":"sms.Hlr"},"noAuthentication":false,"description":"Get the receiver operator","iamActions":[{"name":"sms:apiovh:virtualNumbers/outgoing/hlr/get","required":true}]}],"description":"Sms operator informations"}],"resourcePath":"/sms","basePath":"https://eu.api.ovh.com/1.0","models":{"iam.ResourceMetadata":{"id":"ResourceMetadata","namespace":"iam","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Resource display name","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Unique identifier of the resource","required":false},"state":{"type":"iam.ResourceMetadata.StateEnum","fullType":"iam.ResourceMetadata.StateEnum","canBeNull":true,"readOnly":true,"description":"Resource state","required":false},"tags":{"type":"map[string]string","fullType":"map[string]string","canBeNull":true,"readOnly":true,"description":"Resource tags. Tags that were internally computed are prefixed with ovh:","required":false},"urn":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Unique resource name used in policies","required":false}}},"iam.ResourceMetadata.StateEnum":{"id":"StateEnum","namespace":"iam.ResourceMetadata","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"],"enumType":"string"},"iam.resource.TagFilter":{"id":"TagFilter","namespace":"iam.resource","description":"Resource tag filter","properties":{"operator":{"type":"iam.resource.TagFilter.OperatorEnum","fullType":"iam.resource.TagFilter.OperatorEnum","canBeNull":true,"readOnly":true,"description":"Operator to use in order to filter on the value (defaults to 'EQ')","required":false},"value":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Value to use in order to filter tags","required":false}}},"iam.resource.TagFilter.OperatorEnum":{"id":"OperatorEnum","namespace":"iam.resource.TagFilter","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"],"enumType":"string"},"order.CurrencyCodeEnum":{"id":"CurrencyCodeEnum","namespace":"order","enum":["AUD","CAD","CZK","EUR","GBP","INR","LTL","MAD","N/A","PLN","SGD","TND","USD","XOF","points"],"enumType":"string"},"order.Price":{"id":"Price","namespace":"order","description":"Price with it's currency and textual representation","properties":{"currencyCode":{"type":"order.CurrencyCodeEnum","canBeNull":false,"readOnly":false,"required":false},"text":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"value":{"type":"double","canBeNull":false,"readOnly":false,"required":false}}},"reference.CountryEnum":{"id":"CountryEnum","namespace":"reference","description":"All country prices accessible from a reference","enum":["all","ca","cz","de","en","es","fi","fr","gb","ie","it","lt","ma","nl","pl","pp","pt","qc","ru","sk","sn","tn","we"],"enumType":"string"},"service.RenewType":{"id":"RenewType","namespace":"service","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"The service is automatically renewed","required":false},"deleteAtExpiration":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"The service will be deleted at expiration","required":false},"forced":{"type":"boolean","canBeNull":false,"readOnly":false,"description":"The service forced to be renewed","required":false},"manualPayment":{"type":"boolean","canBeNull":true,"readOnly":false,"description":"The service needs to be manually renewed and paid","required":false},"period":{"type":"long","canBeNull":true,"readOnly":false,"description":"period of renew in month","required":false}}},"service.RenewalTypeEnum":{"id":"RenewalTypeEnum","namespace":"service","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","automaticV2024","manual","oneShot","option"],"enumType":"string"},"service.StateEnum":{"id":"StateEnum","namespace":"service","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"],"enumType":"string"},"services.Service":{"id":"Service","namespace":"services","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Indicates that the service can be set up to be deleted at expiration","required":false},"contactAdmin":{"type":"string","fullType":"coreTypes.AccountId:string","canBeNull":false,"readOnly":true,"required":false},"contactBilling":{"type":"string","fullType":"coreTypes.AccountId:string","canBeNull":false,"readOnly":true,"required":false},"contactTech":{"type":"string","fullType":"coreTypes.AccountId:string","canBeNull":false,"readOnly":true,"required":false},"creation":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"domain":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"engagedUpTo":{"type":"date","fullType":"date","canBeNull":true,"readOnly":true,"required":false},"expiration":{"type":"date","fullType":"date","canBeNull":false,"readOnly":true,"required":false},"possibleRenewPeriod":{"type":"long[]","fullType":"long[]","canBeNull":true,"readOnly":true,"description":"All the possible renew period of your service in month","required":false},"renew":{"type":"service.RenewType","fullType":"service.RenewType","canBeNull":true,"readOnly":false,"description":"Way of handling the renew","required":false},"renewalType":{"type":"service.RenewalTypeEnum","fullType":"service.RenewalTypeEnum","canBeNull":false,"readOnly":true,"required":false},"serviceId":{"type":"long","fullType":"coreTypes.ServiceId:long","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"service.StateEnum","fullType":"service.StateEnum","canBeNull":false,"readOnly":true,"required":false}}},"sms.Account":{"id":"Account","namespace":"sms","description":"SMS details","properties":{"automaticRecreditAmount":{"type":"sms.PackQuantityAutomaticRecreditEnum","fullType":"sms.PackQuantityAutomaticRecreditEnum","canBeNull":true,"readOnly":false,"required":false},"callBack":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"URL called when state of a sent SMS changes","required":false},"channel":{"type":"sms.ChannelEnum","fullType":"sms.ChannelEnum","canBeNull":false,"readOnly":true,"description":"For what purpose this account can be used for","required":false},"creditThresholdForAutomaticRecredit":{"type":"double","fullType":"double","canBeNull":false,"readOnly":false,"description":"Credit threshold after which an automatic recredit is launched","required":false},"creditsHoldByQuota":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false},"creditsLeft":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false},"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"smpp":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the account can be used for smpp or not","required":false},"smsResponse":{"type":"sms.Response","fullType":"sms.Response","canBeNull":false,"readOnly":false,"required":false},"status":{"type":"sms.StatusAccountEnum","fullType":"sms.StatusAccountEnum","canBeNull":false,"readOnly":true,"required":false},"stopCallBack":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"URL called when a STOP is received after a receiver replied stop to a SMS","required":false},"templates":{"type":"sms.Templates","fullType":"sms.Templates","canBeNull":false,"readOnly":false,"required":false},"userQuantityWithQuota":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false}}},"sms.AccountWithIAM":{"id":"Account","namespace":"sms","description":"SMS details","properties":{"automaticRecreditAmount":{"type":"sms.PackQuantityAutomaticRecreditEnum","fullType":"sms.PackQuantityAutomaticRecreditEnum","canBeNull":true,"readOnly":false,"required":false},"callBack":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"URL called when state of a sent SMS changes","required":false},"channel":{"type":"sms.ChannelEnum","fullType":"sms.ChannelEnum","canBeNull":false,"readOnly":true,"description":"For what purpose this account can be used for","required":false},"creditThresholdForAutomaticRecredit":{"type":"double","fullType":"double","canBeNull":false,"readOnly":false,"description":"Credit threshold after which an automatic recredit is launched","required":false},"creditsHoldByQuota":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false},"creditsLeft":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false},"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"required":false},"iam":{"type":"iam.ResourceMetadata","canBeNull":true,"readOnly":true,"description":"IAM resource metadata","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"smpp":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Whether the account can be used for smpp or not","required":false},"smsResponse":{"type":"sms.Response","fullType":"sms.Response","canBeNull":false,"readOnly":false,"required":false},"status":{"type":"sms.StatusAccountEnum","fullType":"sms.StatusAccountEnum","canBeNull":false,"readOnly":true,"required":false},"stopCallBack":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"URL called when a STOP is received after a receiver replied stop to a SMS","required":false},"templates":{"type":"sms.Templates","fullType":"sms.Templates","canBeNull":false,"readOnly":false,"required":false},"userQuantityWithQuota":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false}}},"sms.AlertThreshold":{"id":"AlertThreshold","namespace":"sms","description":"A structure describing all information about alert threshold informations","properties":{"alertEmail":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"alertNumber":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"alertThreshold":{"type":"long","canBeNull":false,"readOnly":false,"required":false},"support":{"type":"sms.SupportEnum","canBeNull":false,"readOnly":false,"required":false}}},"sms.AllowedIPs":{"id":"AllowedIPs","namespace":"sms","description":"Smpp allowed IPs","properties":{"action":{"type":"sms.AllowedIPsActionEnum","fullType":"sms.AllowedIPsActionEnum","canBeNull":false,"readOnly":false,"description":"Action to perform on the provided IPs","required":true},"ips":{"type":"ip[]","fullType":"ip[]","canBeNull":false,"readOnly":false,"description":"List of IPs to add or remove","required":true}}},"sms.AllowedIPsActionEnum":{"id":"AllowedIPsActionEnum","namespace":"sms","description":"Smpp allowed IPs action","enum":["add","remove"],"enumType":"string"},"sms.Batch":{"id":"Batch","namespace":"sms","description":"Batch of SMS to send","properties":{"accountID":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"SMS account ID","required":false},"createdAt":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation datetime","required":false},"errors":{"type":"sms.BatchError[]","fullType":"sms.BatchError[]","canBeNull":false,"readOnly":true,"description":"Details on error(s) on the batch, if any","required":false},"estimatedCredits":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"description":"The estimated cost of the batch in credits","required":false},"finishedAt":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Datetime when the batch finished processing SMSs","required":false},"from":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"SMS sender","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Batch ID","required":false},"message":{"type":"text","fullType":"text","canBeNull":false,"readOnly":true,"description":"SMS message","required":false},"name":{"type":"text","fullType":"text","canBeNull":false,"readOnly":true,"description":"Batch name","required":false},"processedRecords":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of processed records in this batch","required":false},"receivers":{"type":"phoneNumber[]","fullType":"phoneNumber[]","canBeNull":true,"readOnly":true,"description":"SMS receivers list","required":false},"sentAt":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Datetime when the SMSs of the batch are sent (based on deferred time if exists)","required":false},"slotID":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Slot ID","required":false},"startedAt":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Datetime when the batch started processing SMSs","required":false},"status":{"type":"sms.BatchStatusEnum","fullType":"sms.BatchStatusEnum","canBeNull":false,"readOnly":true,"description":"Batch status","required":false},"totalRecords":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Total number of records in this batch","required":false},"updatedAt":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Last update datetime","required":false}}},"sms.BatchClassEnum":{"id":"BatchClassEnum","namespace":"sms","description":"SMS classes","enum":["FLASH","PHONE","SIM"],"enumType":"string"},"sms.BatchError":{"id":"BatchError","namespace":"sms","description":"Batch error details","properties":{"message":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Error message","required":false},"receiver":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Receiver that triggered the error","required":false}}},"sms.BatchParams":{"id":"BatchParams","namespace":"sms","description":"Params to create a batch","properties":{"class":{"type":"sms.BatchClassEnum","fullType":"sms.BatchClassEnum","canBeNull":false,"readOnly":false,"description":"Deprecated: SMS class","required":false},"deferred":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":false,"description":"SMS deferred sending date","required":false},"from":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"SMS sender. Either \"from\" or \"senderForResponse\" must be passed","required":false},"message":{"type":"text","fullType":"text","canBeNull":false,"readOnly":false,"description":"SMS message","required":true},"name":{"type":"text","fullType":"text","canBeNull":false,"readOnly":false,"description":"Batch name","required":false},"noStop":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"STOP clause not needed","required":false},"senderForResponse":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Ask to compute a sender that allows response. Either \"from\" or \"senderForResponse\" must be passed","required":false},"slotID":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"SMS receivers slot ID. Either \"to\" or \"slotID\" must be passed","required":false},"tag":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"SMS tag","required":false},"to":{"type":"phoneNumber[]","fullType":"phoneNumber[]","canBeNull":false,"readOnly":false,"description":"SMS receivers list. Either \"to\" or \"slotID\" must be passed","required":false}}},"sms.BatchStatistics":{"id":"BatchStatistics","namespace":"sms","description":"Batch's statistics","properties":{"credits":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"description":"The cost of the batch in credits, computed during batch processing","required":false},"delivered":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of SMS that are delivered","required":false},"estimatedCredits":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"description":"The estimated cost of the batch in credits, computed before batch processing","required":false},"failed":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of SMS in error","required":false},"id":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Batch ID","required":false},"pending":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of SMS that are in pending status","required":false},"sent":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of SMS that are sent to the broker","required":false},"stoplisted":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of SMS that received a STOP by the receiver","required":false}}},"sms.BatchStatusEnum":{"id":"BatchStatusEnum","namespace":"sms","description":"Batch statuses","enum":["CANCELED","CANCELING","COMPLETED","FAILED","INSERTED","INSERTING","PENDING","TO_CANCEL"],"enumType":"string"},"sms.BatchUpdateParams":{"id":"BatchUpdateParams","namespace":"sms","description":"Params to update a batch","properties":{"name":{"type":"text","fullType":"text","canBeNull":false,"readOnly":false,"description":"Batch name","required":true}}},"sms.BillingCountryEnum":{"id":"BillingCountryEnum","namespace":"sms","description":"Countries where we sell SMS credits","enum":["es","fr","gb","ie","it","pl"],"enumType":"string"},"sms.Blacklist":{"id":"Blacklist","namespace":"sms","description":"SMS blacklist","properties":{"batchID":{"type":"uuid","fullType":"uuid","canBeNull":true,"readOnly":true,"description":"ID of the batch responsible of the blacklist","required":false},"dateCreation":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false},"number":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The sms number blacklisted","required":false},"smsOutgoingID":{"type":"long","fullType":"long","canBeNull":true,"readOnly":true,"description":"ID of the outgoing SMS responsible of the blacklist","required":false}}},"sms.ChannelEnum":{"id":"ChannelEnum","namespace":"sms","description":"In case of smpp the channel can not be \"both\"","enum":["both","marketing","transactional"],"enumType":"string"},"sms.CharsetEnum":{"id":"CharsetEnum","namespace":"sms","description":"The charset format","enum":["UTF-8"],"enumType":"string"},"sms.ChatAccess":{"id":"ChatAccess","namespace":"sms","description":"The web access for your virtual number chat application","properties":{"creationDate":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"The creation date of this access","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"url":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The url of the web access","required":false}}},"sms.ClassEnum":{"id":"ClassEnum","namespace":"sms","description":"Deprecated: The sms class of sms sending job","enum":["flash","phoneDisplay","sim","toolkit"],"enumType":"string"},"sms.CodingEnum":{"id":"CodingEnum","namespace":"sms","description":"The sms coding","enum":["7bit","8bit"],"enumType":"string"},"sms.CountryEnum":{"id":"CountryEnum","namespace":"sms","description":"All country suffixes accessible for sms services and \"all\" available","enum":["ad","ae","af","ag","ai","al","all","am","an","ao","ar","at","au","aw","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bm","bn","bo","br","bs","bt","bw","by","bz","ca","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cy","cz","de","dk","dm","dz","ec","ee","eg","es","et","fi","fj","fk","fo","fr","ga","gb","gd","ge","gf","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hn","hr","ht","hu","id","ie","il","in","io","iq","ir","is","it","jm","jo","jp","ke","kg","kh","km","kn","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","md","me","mg","mk","ml","mn","mo","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","ng","ni","nl","no","np","nz","om","pa","pe","pf","pg","ph","pk","pl","ps","pt","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","si","sk","sl","sm","sn","so","sr","st","sv","sy","sz","tc","td","tg","th","tj","tl","tm","tn","to","tr","tt","tw","tz","ua","ug","us","uy","uz","vc","ve","vg","vi","vn","vu","ws","ye","yt","za","zm","zw"],"enumType":"string"},"sms.DestinationRates":{"id":"DestinationRates","namespace":"sms","description":"Rates of a given destination","properties":{"country":{"type":"string","canBeNull":false,"readOnly":false,"description":"The country full name","required":false},"countryCode":{"type":"sms.CountryEnum","canBeNull":false,"readOnly":false,"description":"The country 2-letters code","required":false},"credit":{"type":"double","canBeNull":false,"readOnly":false,"description":"Credits consumed by sending one SMS towards the given destination","required":false},"price":{"type":"order.Price","canBeNull":false,"readOnly":false,"description":"Price of one SMS sent towards the given destination","required":false},"vatRate":{"type":"double","canBeNull":false,"readOnly":false,"description":"The VAT rate applied from the provided billing country.","required":false}}},"sms.DocumentWayTypeEnum":{"id":"DocumentWayTypeEnum","namespace":"sms","description":"Way type","enum":["incoming","outgoing"],"enumType":"string"},"sms.EncodingEnum":{"id":"EncodingEnum","namespace":"sms","description":"The SMS available characters class","enum":["7bits","unicode"],"enumType":"string"},"sms.Exception":{"id":"Exception","namespace":"sms","description":"Sms reach list","properties":{"countrySuffixe":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The abreviated country code.","required":false},"messages":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":true,"description":"The exception message","required":false},"operators":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The list of operators impacted.","required":false},"restrictionCode":{"type":"sms.RestrictionCodeEnum","fullType":"sms.RestrictionCodeEnum","canBeNull":false,"readOnly":true,"description":"The type of routing restriction imposed by the operator","required":false},"substitution":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"The substitution sender used to bypass operator filter","required":false}}},"sms.Hlr":{"id":"Hlr","namespace":"sms","description":"Sms operator informations","properties":{"country":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The country","required":false},"countryCode":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The countryCode prefix number","required":false},"network":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The network name","required":false},"operator":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The operator name","required":false},"region":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The region","required":false}}},"sms.HlrLookupNumber":{"id":"HlrLookupNumber","namespace":"sms","description":"Home Location Register informations. Give informations about a given cellular phone.","properties":{"datetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"HLR creation datetime","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"HLR id","required":false},"msisdn":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"MSISDN","required":false},"operatorCode":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The {Mobile Country Code, Mobile Network Code} unique identifier","required":false},"ported":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Has the MSISDN been ported from its original network","required":false},"reachable":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is the MSISDN currently reachable","required":false},"roaming":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is the MSISDN currently roaming outside its natinal network","required":false},"status":{"type":"sms.HlrStatuses","fullType":"sms.HlrStatuses","canBeNull":false,"readOnly":true,"description":"Status of the HLR request","required":false},"valid":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is the MSISDN valid","required":false}}},"sms.HlrStatuses":{"id":"HlrStatuses","namespace":"sms","description":"The sms coding","enum":["doing","done","error","todo"],"enumType":"string"},"sms.Incoming":{"id":"Incoming","namespace":"sms","description":"Sms history of sms incoming received","properties":{"creationDatetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false},"credits":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"message":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"sender":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"tag":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false}}},"sms.Job":{"id":"Job","namespace":"sms","description":"Sms job","properties":{"creationDatetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false},"credits":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false},"deliveredAt":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"required":false},"deliveryReceipt":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"differedDelivery":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"message":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"messageLength":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"numberOfSms":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"ptt":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"receiver":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"sender":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"sentAt":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"required":false}}},"sms.JobEstimate":{"id":"JobEstimate","namespace":"sms","description":"A structure describing the encoding, length and number of SMS parts of a text message","properties":{"characters":{"type":"long","canBeNull":false,"readOnly":false,"description":"The number of characters the message contains, including invisible escaped characters","required":false},"charactersClass":{"type":"sms.EncodingEnum","canBeNull":false,"readOnly":false,"description":"The characters class that will be used to send the SMS, depending on characters in message","required":false},"maxCharactersPerPart":{"type":"long","canBeNull":false,"readOnly":false,"description":"The number of characters every SMS part can contain, depending on characters class and quantity of parts","required":false},"parts":{"type":"long","canBeNull":false,"readOnly":false,"description":"The quantity of SMS parts the message will be split in","required":false}}},"sms.Outgoing":{"id":"Outgoing","namespace":"sms","description":"Sent SMS","properties":{"batchID":{"type":"uuid","fullType":"uuid","canBeNull":true,"readOnly":true,"description":"ID of batch linked to the SMS","required":false},"creationDatetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation datetime","required":false},"credits":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"description":"Spent credits","required":false},"deliveredAt":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Delivering datetime","required":false},"deliveryReceipt":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Delivery receipt from operator","required":false},"differedDelivery":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Delay before SMS sending","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Identifier","required":false},"message":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"SMS message","required":false},"messageID":{"type":"uuid","fullType":"uuid","canBeNull":true,"readOnly":true,"description":"SMPP messageID","required":false},"messageLength":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"SMS message length","required":false},"numberOfSms":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"SMS message's number of parts","required":false},"ptt":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Code representing SMS state","required":false},"receiver":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"SMS receiver","required":false},"sender":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"SMS sender","required":false},"sentAt":{"type":"datetime","fullType":"datetime","canBeNull":true,"readOnly":true,"description":"Sending datetime","required":false},"tag":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Customer label to categorize SMSs","required":false},"tariffCode":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Tariff code applied on the sms","required":false}}},"sms.PackDetails":{"id":"PackDetails","namespace":"sms","description":"Details about a SMS pack","properties":{"countryCode":{"type":"sms.CountryEnum","canBeNull":false,"readOnly":false,"description":"Destination country code","required":false},"credit":{"type":"double","canBeNull":false,"readOnly":false,"description":"Credits consumed by sending one SMS towards the given destination","required":false},"creditPrice":{"type":"order.Price","canBeNull":false,"readOnly":false,"description":"Price of one credit, including pack's promotion","required":false},"creditQuantityMax":{"type":"long","canBeNull":true,"readOnly":false,"description":"Maximum quantity (excluded) of credit to order to have this price","required":false},"creditQuantityMin":{"type":"long","canBeNull":false,"readOnly":false,"description":"Minimum quantity (included) of credit to order to have this price","required":false},"discountCreditPrice":{"type":"order.Price","canBeNull":true,"readOnly":false,"description":"Price of one credit, during a promotional event","required":false},"discountPercentage":{"type":"long","canBeNull":true,"readOnly":false,"description":"Percentage applied as part of a promotional event","required":false},"discountSmsPrice":{"type":"order.Price","canBeNull":true,"readOnly":false,"description":"Price of one SMS, during a promotional event","required":false},"smsPrice":{"type":"order.Price","canBeNull":false,"readOnly":false,"description":"Price of one SMS sent towards the given destination, including pack's promotion","required":false},"smsQuantityMax":{"type":"long","canBeNull":true,"readOnly":false,"description":"Maximum quantity (excluded) of SMS you can obtain with this pack","required":false},"smsQuantityMin":{"type":"long","canBeNull":false,"readOnly":false,"description":"Minimum quantity (included) of SMS you can obtain with this pack","required":false},"vatRate":{"type":"double","canBeNull":false,"readOnly":false,"description":"The VAT rate applied from the provided billing country.","required":false}}},"sms.PackOffer":{"id":"PackOffer","namespace":"sms","description":"A structure describing all information about an sms pack offer","properties":{"countryDestination":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"giftPrice":{"type":"double","canBeNull":true,"readOnly":false,"required":false},"giftQuantity":{"type":"double","canBeNull":true,"readOnly":false,"required":false},"language":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"price":{"type":"double","canBeNull":false,"readOnly":false,"required":false},"quantity":{"type":"long","canBeNull":false,"readOnly":false,"required":false},"smsQuantity":{"type":"double","canBeNull":false,"readOnly":false,"required":false},"totalPrice":{"type":"double","canBeNull":true,"readOnly":false,"required":false}}},"sms.PackQuantityAutomaticRecreditEnum":{"id":"PackQuantityAutomaticRecreditEnum","namespace":"sms","description":"Pack quantity automatic recredit possibilities","enum":["100","200","250","500","1000","5000","10000"],"enumType":"long"},"sms.PackQuantityEnum":{"id":"PackQuantityEnum","namespace":"sms","description":"Pack quantity levels","enum":["100","200","250","500","1000","2500","5000","10000","25000","50000","100000","1000000"],"enumType":"long"},"sms.Phonebook":{"id":"Phonebook","namespace":"sms","description":"Phone book","properties":{"bookKey":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Identifier of the phonebook","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Phonebook name","required":false},"phoneKey":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Phone key identifier between the phone and phonebooks","required":false}}},"sms.PhonebookContact":{"id":"PhonebookContact","namespace":"sms","description":"Phone book contact","properties":{"group":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Group name of the phonebook","required":false},"homeMobile":{"type":"internationalPhoneNumber","fullType":"internationalPhoneNumber","canBeNull":true,"readOnly":false,"description":"Home mobile phone number of the contact","required":false},"homePhone":{"type":"internationalPhoneNumber","fullType":"internationalPhoneNumber","canBeNull":true,"readOnly":false,"description":"Home landline phone number of the contact","required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Contact identifier","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Contact name","required":false},"surname":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Contact surname","required":false},"workMobile":{"type":"internationalPhoneNumber","fullType":"internationalPhoneNumber","canBeNull":true,"readOnly":false,"description":"Mobile phone office number of the contact","required":false},"workPhone":{"type":"internationalPhoneNumber","fullType":"internationalPhoneNumber","canBeNull":true,"readOnly":false,"description":"Landline phone office number of the contact","required":false}}},"sms.PriorityEnum":{"id":"PriorityEnum","namespace":"sms","description":"The priority of an sms sending","enum":["high","low","medium","veryLow"],"enumType":"string"},"sms.PttDetails":{"id":"PttDetails","namespace":"sms","description":"A structure describing ptt details","properties":{"comment":{"type":"string","canBeNull":false,"readOnly":false,"description":"Ptt informations","required":false},"description":{"type":"string","canBeNull":false,"readOnly":false,"description":"Ptt short description","required":false},"duration":{"type":"sms.PttDurationTypeEnum","canBeNull":false,"readOnly":false,"description":"Ptt volatility type","required":false}}},"sms.PttDurationTypeEnum":{"id":"PttDurationTypeEnum","namespace":"sms","description":"All typology of ptt duration","enum":["indeterminated","permanent","temporary"],"enumType":"string"},"sms.Quota":{"id":"Quota","namespace":"sms","description":"A structure describing all information about quota informations","properties":{"quotaLeft":{"type":"double","canBeNull":false,"readOnly":false,"required":false},"quotaStatus":{"type":"sms.QuotaStatusUserEnum","canBeNull":false,"readOnly":false,"required":false}}},"sms.QuotaStatusUserEnum":{"id":"QuotaStatusUserEnum","namespace":"sms","description":"Current quota status","enum":["active","inactive"],"enumType":"string"},"sms.Receiver":{"id":"Receiver","namespace":"sms","description":"Sms receivers preloaded","properties":{"autoUpdate":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":false,"description":"Download file from URL before sending to contacts (works only with csvUrl and not document ID)","required":false},"canAutoUpdate":{"type":"boolean","fullType":"boolean","canBeNull":false,"readOnly":true,"description":"Is the object compatible with autoUpdate","required":false},"datetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation date of the document","required":false},"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Description name of the document","required":false},"records":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of receiver records in the document","required":false},"slotId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Slot number id","required":false}}},"sms.ReceiversAsynchronousCleanReport":{"id":"ReceiversAsynchronousCleanReport","namespace":"sms","description":"A structure giving operation price and asynchronous task ID","properties":{"taskId":{"type":"long","canBeNull":false,"readOnly":false,"required":false},"totalCreditsRemoved":{"type":"double","canBeNull":false,"readOnly":false,"required":false}}},"sms.RefererSenderEnum":{"id":"RefererSenderEnum","namespace":"sms","description":"All tyoplogy of senders","enum":["custom","domain","line","nic","owner","virtual"],"enumType":"string"},"sms.Response":{"id":"Response","namespace":"sms","description":"A structure describing how to manage an sms Response","properties":{"cgiUrl":{"type":"string","canBeNull":true,"readOnly":false,"description":"Default url callback used for a given response.","required":false},"responseType":{"type":"sms.ResponseTypeEnum","canBeNull":false,"readOnly":false,"required":false},"text":{"type":"string","canBeNull":true,"readOnly":false,"description":"Automatic notification sent by text in case of customer reply.","required":false},"trackingDefaultSmsSender":{"type":"string","canBeNull":true,"readOnly":false,"required":false},"trackingOptions":{"type":"sms.ResponseTrackingOptions[]","canBeNull":true,"readOnly":false,"required":false}}},"sms.ResponseTrackingMediaEnum":{"id":"ResponseTrackingMediaEnum","namespace":"sms","description":"The tracking media response","enum":["email","sms","voice"],"enumType":"string"},"sms.ResponseTrackingOptions":{"id":"ResponseTrackingOptions","namespace":"sms","description":"The tracking media response","properties":{"media":{"type":"sms.ResponseTrackingMediaEnum","canBeNull":false,"readOnly":false,"required":false},"sender":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"target":{"type":"string","canBeNull":false,"readOnly":false,"required":false}}},"sms.ResponseTypeEnum":{"id":"ResponseTypeEnum","namespace":"sms","description":"Response type","enum":["cgi","none","text"],"enumType":"string"},"sms.RestrictionCodeEnum":{"id":"RestrictionCodeEnum","namespace":"sms","description":"Restriction type used by the operator to filter sms.","enum":["ALPHA","BAD_DLR","BLOCKED","CODING","DLR","FLASHONLY","MSISDN"],"enumType":"string"},"sms.Sender":{"id":"Sender","namespace":"sms","description":"SMS senders","properties":{"comment":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Message sent by the moderator","required":false},"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Sender description","required":false},"referer":{"type":"sms.RefererSenderEnum","fullType":"sms.RefererSenderEnum","canBeNull":false,"readOnly":true,"description":"Specify if the sender is custom or not","required":false},"sender":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The sms sender","required":false},"status":{"type":"sms.StatusSenderEnum","fullType":"sms.StatusSenderEnum","canBeNull":false,"readOnly":false,"description":"Sender status","required":false},"type":{"type":"sms.TypeSenderEnum","fullType":"sms.TypeSenderEnum","canBeNull":true,"readOnly":true,"description":"Specify the kind of sender","required":false},"validationMedia":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Validation media identifier","required":false}}},"sms.SenderAvailable":{"id":"SenderAvailable","namespace":"sms","description":"A structure describing all information about senders available","properties":{"referer":{"type":"sms.SenderRefererEnum","canBeNull":false,"readOnly":false,"required":false},"sender":{"type":"string","canBeNull":false,"readOnly":false,"required":false}}},"sms.SenderDocument":{"id":"SenderDocument","namespace":"sms","description":"SMS senders' document","properties":{"createdAt":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Creation datetime","required":false},"description":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"Document description","required":false},"documentID":{"type":"uuid","fullType":"uuid","canBeNull":false,"readOnly":true,"description":"Document ID","required":false},"getUrl":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"URL to get document","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Document name","required":false},"putUrl":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"URL to upload document","required":false},"size":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Document size (in bytes)","required":false}}},"sms.SenderRefererEnum":{"id":"SenderRefererEnum","namespace":"sms","description":"The referer of the available sender","enum":["domain","nichandle"],"enumType":"string"},"sms.Settings":{"id":"Settings","namespace":"sms","description":"SMPP settings","properties":{"endpoints":{"type":"sms.SettingsEndpoints[]","fullType":"sms.SettingsEndpoints[]","canBeNull":false,"readOnly":true,"description":"Addresses of the TLS and non-TLS endpoints","required":false},"status":{"type":"sms.SettingsStatusEnum","fullType":"sms.SettingsStatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the SMPP account","required":false},"systemID":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Username used to connect to OVHcloud SMSC","required":false},"throughput":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of messages allowed per seconds","required":false},"windowing":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"description":"Number of messages treated simultaneously","required":false}}},"sms.SettingsEndpoints":{"id":"SettingsEndpoints","namespace":"sms","description":"SMPP Settings Endpoints","properties":{"secured":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"address of the TLS endpoint: domain:port","required":false},"unsecured":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"address of the non-TLS endpoint: domain:port","required":false}}},"sms.SettingsStatusEnum":{"id":"SettingsStatusEnum","namespace":"sms","description":"Smpp Settings Statuses","enum":["DELETED","ERROR","SUCCESS","UNKNOWN","UPDATING_IP","WAITING_IP"],"enumType":"string"},"sms.SmsSendingReport":{"id":"SmsSendingReport","namespace":"sms","description":"A structure describing all information about quota information","properties":{"ids":{"type":"long[]","canBeNull":false,"readOnly":false,"required":false},"invalidReceivers":{"type":"string[]","canBeNull":false,"readOnly":false,"required":false},"tag":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"totalCreditsRemoved":{"type":"double","canBeNull":false,"readOnly":false,"required":false},"validReceivers":{"type":"string[]","canBeNull":false,"readOnly":false,"required":false}}},"sms.SmsSendingReportUser":{"id":"SmsSendingReportUser","namespace":"sms","description":"A structure describing all information about quota information","properties":{"creditsLeft":{"type":"double","canBeNull":false,"readOnly":false,"required":false},"ids":{"type":"long[]","canBeNull":false,"readOnly":false,"required":false},"invalidReceivers":{"type":"string[]","canBeNull":false,"readOnly":false,"required":false},"tag":{"type":"string","canBeNull":false,"readOnly":false,"required":false},"totalCreditsRemoved":{"type":"double","canBeNull":false,"readOnly":false,"required":false},"validReceivers":{"type":"string[]","canBeNull":false,"readOnly":false,"required":false}}},"sms.StatusAccountEnum":{"id":"StatusAccountEnum","namespace":"sms","description":"Account status","enum":["disable","enable"],"enumType":"string"},"sms.StatusSenderEnum":{"id":"StatusSenderEnum","namespace":"sms","description":"All existing status for a given referer","enum":["disable","enable","refused","waitingValidation"],"enumType":"string"},"sms.SupportEnum":{"id":"SupportEnum","namespace":"sms","description":"The media support used to be contacted in case of alert","enum":["both","mail","sms"],"enumType":"string"},"sms.Task":{"id":"Task","namespace":"sms","description":"Operation on a SMS service","properties":{"function":{"type":"sms.TodoGeneralPublicFunctionsEnum","fullType":"sms.TodoGeneralPublicFunctionsEnum","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"telephony.TaskStatusEnum","fullType":"telephony.TaskStatusEnum","canBeNull":false,"readOnly":true,"required":false},"step":{"type":"sms.TodoGeneralPublicStepsEnum","fullType":"sms.TodoGeneralPublicStepsEnum","canBeNull":false,"readOnly":true,"required":false},"taskId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false}}},"sms.TemplateControl":{"id":"TemplateControl","namespace":"sms","description":"Sms template for moderation (Needed to send in US country)","properties":{"activity":{"type":"sms.TypeTemplateEnum","fullType":"sms.TypeTemplateEnum","canBeNull":false,"readOnly":false,"description":"Specify the kind of template","required":false},"comment":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Message sent by the moderator","required":false},"datetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"description":"Template creation datetime","required":false},"description":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Template description","required":false},"message":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area.","required":false},"name":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"description":"Name of the template","required":false},"status":{"type":"sms.StatusSenderEnum","fullType":"sms.StatusSenderEnum","canBeNull":false,"readOnly":false,"description":"Template status","required":false}}},"sms.Templates":{"id":"Templates","namespace":"sms","description":"A structure describing all information about templates informations","properties":{"customizedEmailMode":{"type":"boolean","canBeNull":false,"readOnly":false,"required":false},"customizedSmsMode":{"type":"boolean","canBeNull":false,"readOnly":false,"required":false},"emailBody":{"type":"string","canBeNull":true,"readOnly":false,"required":false},"emailFrom":{"type":"string","canBeNull":true,"readOnly":false,"required":false},"emailSubject":{"type":"string","canBeNull":true,"readOnly":false,"required":false},"smsBody":{"type":"string","canBeNull":true,"readOnly":false,"required":false}}},"sms.TodoGeneralPublicFunctionsEnum":{"id":"TodoGeneralPublicFunctionsEnum","namespace":"sms","description":"The task function","enum":["cleanSmsReceivers"],"enumType":"string"},"sms.TodoGeneralPublicStepsEnum":{"id":"TodoGeneralPublicStepsEnum","namespace":"sms","description":"The task step","enum":["checkOrder","createHlrs","finishing","sendMailReport","starting","waitForHlrs"],"enumType":"string"},"sms.TypeSenderEnum":{"id":"TypeSenderEnum","namespace":"sms","description":"All existing types for a given sender","enum":["alpha","numeric","shortcode","time2chat","virtual"],"enumType":"string"},"sms.TypeTemplateEnum":{"id":"TypeTemplateEnum","namespace":"sms","description":"All existing types for a given template","enum":["alerting","authentification","transactional"],"enumType":"string"},"sms.User":{"id":"User","namespace":"sms","description":"SMS users","properties":{"alertThresholdInformations":{"type":"sms.AlertThreshold","fullType":"sms.AlertThreshold","canBeNull":false,"readOnly":false,"required":false},"callBack":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"URL called when state of a sent SMS changes","required":false},"ipRestrictions":{"type":"string[]","fullType":"string[]","canBeNull":false,"readOnly":false,"required":false},"login":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The sms user login","required":false},"password":{"type":"string","fullType":"string","canBeNull":false,"readOnly":false,"required":false},"quotaInformations":{"type":"sms.Quota","fullType":"sms.Quota","canBeNull":false,"readOnly":false,"required":false},"stopCallBack":{"type":"string","fullType":"string","canBeNull":true,"readOnly":false,"description":"URL called when a STOP is received after a receiver replied stop to a SMS","required":false}}},"sms.VirtualNumber":{"id":"VirtualNumber","namespace":"sms","description":"Virtual numbers","properties":{"countryCode":{"type":"sms.VirtualNumberIsoCountryCodeEnum","fullType":"sms.VirtualNumberIsoCountryCodeEnum","canBeNull":false,"readOnly":true,"description":"The ISO formated country code of the number","required":false},"number":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The virtual number","required":false}}},"sms.VirtualNumberGenericService":{"id":"VirtualNumberGenericService","namespace":"sms","description":"Virtual numbers","properties":{"countryCode":{"type":"sms.VirtualNumberIsoCountryCodeEnum","fullType":"sms.VirtualNumberIsoCountryCodeEnum","canBeNull":false,"readOnly":true,"description":"The ISO formated country code of the number","required":false},"number":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The virtual number","required":false}}},"sms.VirtualNumberGenericServiceWithIAM":{"id":"VirtualNumberGenericService","namespace":"sms","description":"Virtual numbers","properties":{"countryCode":{"type":"sms.VirtualNumberIsoCountryCodeEnum","fullType":"sms.VirtualNumberIsoCountryCodeEnum","canBeNull":false,"readOnly":true,"description":"The ISO formated country code of the number","required":false},"iam":{"type":"iam.ResourceMetadata","canBeNull":true,"readOnly":true,"description":"IAM resource metadata","required":false},"number":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"The virtual number","required":false}}},"sms.VirtualNumberIsoCountryCodeEnum":{"id":"VirtualNumberIsoCountryCodeEnum","namespace":"sms","description":"The ISO formated country code of the number","enum":["be","ch","de","es","fr","uk"],"enumType":"string"},"sms.VirtualNumberJob":{"id":"VirtualNumberJob","namespace":"sms","description":"Sms job","properties":{"creationDatetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false},"credits":{"type":"double","fullType":"double","canBeNull":false,"readOnly":true,"required":false},"deliveryReceipt":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"differedDelivery":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"id":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"message":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"messageLength":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"numberOfSms":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"ptt":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false},"receiver":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false}}},"telephony.ContactsExportFormatsEnum":{"id":"ContactsExportFormatsEnum","namespace":"telephony","description":"Export file format","enum":["csv"],"enumType":"string"},"telephony.PcsFile":{"id":"PcsFile","namespace":"telephony","description":"Telephony API related file hosted","properties":{"filename":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"telephony.PcsFileStatusEnum","fullType":"telephony.PcsFileStatusEnum","canBeNull":false,"readOnly":true,"required":false},"url":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"urlExpirationDatetime":{"type":"datetime","fullType":"datetime","canBeNull":false,"readOnly":true,"required":false}}},"telephony.PcsFileStatusEnum":{"id":"PcsFileStatusEnum","namespace":"telephony","description":"File providing task status","enum":["doing","done","error","todo"],"enumType":"string"},"telephony.Task":{"id":"Task","namespace":"telephony","description":"Operation on a telephony service","properties":{"action":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"description":"Action associated with the task","required":false},"message":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Potential failure reason of the task","required":false},"objectCreated":{"type":"string","fullType":"string","canBeNull":true,"readOnly":true,"description":"Object potentially created at the end of the task","required":false},"serviceType":{"type":"string","fullType":"string","canBeNull":false,"readOnly":true,"required":false},"status":{"type":"telephony.TaskStatusEnum","fullType":"telephony.TaskStatusEnum","canBeNull":false,"readOnly":true,"description":"Status of the task","required":false},"taskId":{"type":"long","fullType":"long","canBeNull":false,"readOnly":true,"required":false}}},"telephony.TaskStatusEnum":{"id":"TaskStatusEnum","namespace":"telephony","description":"Task status","enum":["doing","done","error","pause","todo"],"enumType":"string"}}}