Ballerina library

isendpro

Module isendpro

OverviewPrerequisites

API

Client

Definitions

BlacklistResponse
BlacklistresponseEtat
BlacklistresponseEtatEtat
ClientHttp1Settings
ConnectionConfig
CountRequest
CountResponse
CountresponseEtat
CountresponseEtatEtat
CreditResponse
CreditresponseEtat
Directorycreatereponse
DirectorycreatereponseEtat
DirectorycreatereponseEtatEtat
Directorycreaterequest
Directorymodifreponse
DirectorymodifreponseEtat
DirectorymodifreponseEtatEtat
DirectoryUpdateRequest
ErreurEtat
ErreurEtatEtat
Error
HLRrequest
HLRResponse
HlrresponseEtat
HlrresponseEtatEtat
ProxyConfig
ShortlinkRequest
ShortlinkResponse
ShortlinkresponseEtat
ShortlinkresponseEtatEtat
SMSRequest
SMSResponse
SmsresponseEtat
SmsresponseEtatEtat
SmsUniqueRequest
SubaccountAddRequest
SubaccountAddResponse
SubaccountaddresponseEtat
SubaccountaddresponseEtatEtat
SubaccountRequest
SubaccountResponse
SubaccountresponseEtat
SubaccountresponseEtatEtat

ballerinax/isendpro Ballerina library

1.5.1

Overview

This is a generated connector for iSendPro v1.1.1 OpenAPI specification.

iSendPro provides the capability to the capability to send SMS to one or more recipients.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Clients

isendpro: Client

Isolated

This is a generated connector for iSendPro v1.1.1 OpenAPI specification. [1] List of features:

  • sending SMS to one or more recipients,
  • HLR lookup,
  • recovery of campaign summaries,
  • directory management,
  • addition to blacklist.
  • counting of the number of characters in SMS

[2] To use this API you must:

  • Create an iSendPro account on https://isendpro.com/
  • Credit your account
  • Note: obtaining a test credit possible under certain conditions
  • Write down your account key (keyid)
  • It will be essential for you to use the API
  • You can find it in the section my "account", sub-section "my API"
  • Configure IP control
  • IP control can be configured in the my "account" section, "my API" sub-section
  • This is a whitelist system, you need to enter the IPs used to call the API
  • You can also completely disable IP control

Constructor

Gets invoked to initialize the connector. The connector initialization doesn't require setting the API credentials. Create an iSendPro account and obtain tokens by following this guide Operations require passing the token as a parameter.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://apirest.isendpro.com/cgi-bin" - URL of the target service

getCampaign

Isolated FunctionRemote Function
function getCampaign(string keyid, string rapportCampagne, string dateDeb, string dateFin) returns string|error

Returns the SMS sent over a given period

Parameters
  • rapportCampagne string - Must be "1"
  • dateDeb string - start date in format YYYY-MM-DD hh:mm
  • dateFin string - End date in format YYYY-MM-DD hh:mm
Return Type

count

Isolated FunctionRemote Function
function count(CountRequest payload) returns CountResponse|error

Count the number of characters.

Parameters
Return Type

getCredit

Isolated FunctionRemote Function
function getCredit(string keyid, string credit) returns CreditResponse|error

Get credit

Parameters
  • credit string - Type of response requested, 1 for euro, 2 for euro + quantity estimate
Return Type

removeBlacklistNumber

Isolated FunctionRemote Function
function removeBlacklistNumber(string keyid, string delListeNoire, string num) returns BlacklistResponse|error

Add a blacklisted number

Parameters
  • delListeNoire string - Must be "1"
  • num string - Mobile number to be deleted
Return Type

getBlacklist

Isolated FunctionRemote Function
function getBlacklist(string keyid, string getListeNoire) returns string|error

Return the blacklist

Parameters
  • getListeNoire string - Must be "1"
Return Type

validateNumber

Isolated FunctionRemote Function
function validateNumber(HLRrequest payload) returns HLRResponse|error

Check the validity of a number

Parameters
Return Type

updateDirectory

Isolated FunctionRemote Function
function updateDirectory(DirectoryUpdateRequest payload) returns Directorymodifreponse|error

Update directory

Parameters
Return Type

createDirectory

Isolated FunctionRemote Function
function createDirectory(Directorycreaterequest payload) returns Directorycreatereponse|error

Create directory

Parameters
Return Type

addBlacklistNumber

Isolated FunctionRemote Function
function addBlacklistNumber(string keyid, string setlisteNoire, string num) returns BlacklistResponse|error

Add a blacklisted number.

Parameters
  • setlisteNoire string - Must be "1"
  • num string - mobile number to be blacklisted
Return Type
Isolated FunctionRemote Function
function addShortlink(ShortlinkRequest payload) returns ShortlinkResponse|error

add a shortlink

Parameters
Return Type

sendSms

Isolated FunctionRemote Function
function sendSms(SmsUniqueRequest payload) returns SMSResponse|error

Send a text message.

Parameters
Return Type

sendSmsMulti

Isolated FunctionRemote Function
function sendSmsMulti(SMSRequest payload) returns SMSResponse|error

Send multiple text messages

Parameters
Return Type

updateSubAccount

Isolated FunctionRemote Function
function updateSubAccount(SubaccountRequest payload) returns SubaccountResponse|error

Edit a subaccount

Parameters
Return Type

addSubAccount

Isolated FunctionRemote Function
function addSubAccount(SubaccountAddRequest payload) returns SubaccountAddResponse|error

Add a sub account

Parameters
Return Type

Records

isendpro: BlacklistResponse

Fields

isendpro: BlacklistresponseEtat

Fields

isendpro: BlacklistresponseEtatEtat

Fields
  • listeNoire string - Must be "OK"
  • tel string - Telephone number to be blacklisted. National French or international format.

isendpro: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

isendpro: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

isendpro: CountRequest

Fields
  • date_envoi string? - Date sent in YYYY-MM-DD format hh: mm. This parameter is optional, if it is omitted, the sending is carried out immediately.
  • emetteur string? -
    • The sender must be an alphanumeric string between 4 and 11 characters long.
    • The accepted characters are numbers between 0 and 9, letters between A and Z and space.
    • It cannot consist of only numbers.
    • For the modification of the transmitter and within the framework of commercial campaigns, the operators contractually impose to add at the end of the message the text "STOP XXXXX". As a result, the message sent cannot exceed a length of 148 characters instead of 160 characters, the "STOP" being added automatically.
  • gmt_zone string? - Time zone of the date sent
  • nostop string? - If the message is not for commercial purposes, you can request to withdraw the obligation from the STOP. Once your request has been validated by our services, you can remove the STOP SMS mention by adding nostop = "1"
  • num string - Telephone number in national (example 0680010203) or international (example 33680010203) format
  • sms string - Message to send to recipients. The message must be encoded in utf-8 format and contain only characters existing in the GSM alphabet. It is also possible to send (abroad only) SMS in UCS-2, see parameter ucs2 for more details.
  • smslong string(default "999") - The long SMS allows you to exceed the limit of 160 characters by sending a message consisting of of several SMS. Up to 6 concatenated SMS can be sent for a maximum total length of 918 characters per message. For technical reasons, the limit per concatenated SMS is 153 characters. If the transmitter is changed, consider the automatic addition of 12 characters of the "STOP SMS". To send a smslong, you must add the smslong parameter to the calls. The value of SMS must be the maximum number of concatenated SMS allowed. In order not to have this error message and to obtain a dynamic calculation of the number of SMS then you must enter smslong = "999"
  • tracker string? - Le tracker doit être une chaine alphanumérique de moins de 50 caractères. Ce tracker sera ensuite renvoyé en paramètre des urls pour les retours des accusés de réception.
  • ucs2 string? - It is also possible to send SMS in non-Latin alphabet (Russian, Chinese, Arabic, etc.) on numbers outside mainland France. To do this, the request should be encoded in UTF-8 format and contain the argument ucs2 = "1" Due to technical constraints, 1 unique SMS cannot exceed 70 characters (instead of of the usual 160) and in the case of long SMS, each SMS cannot exceed 67 characters.

isendpro: CountResponse

Fields

isendpro: CountresponseEtat

Fields

isendpro: CountresponseEtatEtat

Fields
  • nb_character string? - Number of characters
  • nb_sms string? - Number of sms needed

isendpro: CreditResponse

Fields

isendpro: CreditresponseEtat

Fields
  • credit decimal? - Amount of credit remaining
  • quantite string? - Credit equivalence in number of SMS to Metropolitan France.

isendpro: Directorycreatereponse

Fields

isendpro: DirectorycreatereponseEtat

Fields

isendpro: DirectorycreatereponseEtatEtat

Fields
  • code string - Return code. See "return code table" in the appendix of the documentation
  • message string? - Label associated with the return code.
  • repertoireId string? - directoryId of the directory created.

isendpro: Directorycreaterequest

Fields
  • repertoireEdit string - Action à réaliser doit valoir "create" ici.
  • repertoireNom string - Nom du répertoire (libellé) à créer

isendpro: Directorymodifreponse

Fields

isendpro: DirectorymodifreponseEtat

Fields

isendpro: DirectorymodifreponseEtatEtat

Return code table. If successful, a separate return code for each number submitted.

Fields
  • code string - Return code. See "return code table" in the appendix of the documentation
  • message string? - Label associated with the return code.
  • repertoireId string? - directory ID passed as argument during the call

isendpro: DirectoryUpdateRequest

Fields
  • champ1 string[]? - Contact names
  • champ10 string[]? - Champs I des contacts
  • champ11 string[]? - Champs J des contacts
  • champ12 string[]? - Champs K des contacts
  • champ13 string[]? - Champs L des contacts
  • champ14 string[]? - Champs M des contacts
  • champ15 string[]? - Champs N des contacts
  • champ16 string[]? - Champs O des contacts
  • champ17 string[]? - Champs P des contacts
  • champ18 string[]? - Champs Q des contacts
  • champ19 string[]? - Champs R des contacts
  • champ2 string[]? - Champs A des contacts
  • champ20 string[]? - Champs S des contacts
  • champ21 string[]? - Champs T des contacts
  • champ22 string[]? - Champs U des contacts
  • champ23 string[]? - Champs V des contacts
  • champ24 string[]? - Champs W des contacts
  • champ25 string[]? - Champs X des contacts
  • champ26 string[]? - Champs Y des contacts
  • champ27 string[]? - Champs Z des contacts
  • champ3 string[]? - Champs B des contacts
  • champ4 string[]? - Champs C des contacts
  • champ5 string[]? - Champs D des contacts
  • champ6 string[]? - Champs E des contacts
  • champ7 string[]? - Champs F des contacts
  • champ8 string[]? - Champs G des contacts
  • champ9 string[]? - Champs H des contacts
  • num string[] - list of phone numbers to add or delete
  • repertoireEdit string - Action to perform, "add" for adding numbers, "del" for removing numbers
  • repertoireId string - directory ID of the target directory

isendpro: ErreurEtat

Fields

isendpro: ErreurEtatEtat

Fields
  • code string? - Return code. See "return code table" in the appendix of the documentation
  • message string? - Label associated with the return code

isendpro: Error

Fields

isendpro: HLRrequest

Fields
  • num string[] - Phone number list

isendpro: HLRResponse

Fields

isendpro: HlrresponseEtat

Fields

isendpro: HlrresponseEtatEtat

Fields
  • operator string - Associated operator (if valid number)
  • tel string - Phone number concerned

isendpro: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

isendpro: ShortlinkRequest

Fields

isendpro: ShortlinkResponse

Fields

isendpro: ShortlinkresponseEtat

Fields

isendpro: ShortlinkresponseEtatEtat

Fields

isendpro: SMSRequest

Fields
  • date_envoi string? - Optional parameter, date of sending in YYYY-MM-DD hh: mm format
  • emetteur string? - The sender must be an alphanumeric string between 4 and 11 characters long. Accepted characters are numbers between 0 and 9, letters between A and Z and space. It cannot consist of only numbers. For modification from the sender and in the context of commercial campaigns, the operators contractually impose the following text to be added at the end of the message: STOP XXXXX Therefore, the message sent may not exceed a length of 148 characters instead of 160 characters, the STOP being added automatically.
  • gmt_zone string? - Time zone of the date sent
  • nostop string? - If the message is not for commercial purposes, you can request to withdraw the obligation from the STOP. Once your request has been validated by our services, you can remove the STOP SMS mention by adding nostop = "1"
  • repertoireId string? - Directory ID
  • smslong string? - The long SMS allows you to exceed the limit of 160 characters by sending a message consisting of several SMS. Up to 6 concatenated SMS can be sent for a maximum total length of 918 characters per message. For technical reasons, the limit per concatenated SMS is 153 characters. If the transmitter is changed, consider the automatic addition of 12 characters of the "STOP SMS". To send a smslong, you must add the smslong parameter to the calls. The value of SMS must be the maximum number of concatenated SMS allowed. In order not to get this error message and to obtain a dynamic calculation of the number of SMS then you must enter smslong = "999"
  • ucs2 string? - It is also possible to send SMS in non-Latin alphabet (Russian, Chinese, Arabic, etc.) to numbers outside mainland France. To do this, the request should be encoded in UTF-8 format and contain the argument ucs2 = "1" Due to technical constraints, 1 single SMS cannot exceed 70 characters (instead of the usual 160) and in the case long SMS, each SMS cannot exceed 67 characters.

isendpro: SMSResponse

Fields

isendpro: SmsresponseEtat

Fields

isendpro: SmsresponseEtatEtat

Fields
  • code int? - Return code. See "return code table" in the appendix of the documentation
  • message string? - Label associated with the return code
  • smslong string? - Number of long SMS invoiced
  • tel string? - Phone number concerned

isendpro: SmsUniqueRequest

Fields
  • date_envoi string? - Date sent in YYYY-MM-DD format hh: mm. This parameter is optional, if it is omitted, the sending is carried out immediately.
  • emetteur string? -
    • The sender must be an alphanumeric string between 4 and 11 characters long.
    • The accepted characters are numbers between 0 and 9, letters between A and Z and space.
    • It cannot consist of only numbers.
    • For the modification of the transmitter and within the framework of commercial campaigns, the operators contractually impose to add at the end of the message the text "STOP XXXXX". As a result, the message sent cannot exceed a length of 148 characters instead of 160 characters, the "STOP" being added automatically.
  • gmt_zone string? - Fuseau horaire de la date d'envoi
  • nostop string? - If the message is not for commercial purposes, you can request to withdraw the obligation from the STOP. Once your request has been validated by our services, you can remove the STOP SMS mention by adding nostop = "1"
  • num string - Telephone number in national (example 0680010203) or international (example 33680010203) format
  • sms string - Message to send to recipients. The message must be encoded in utf-8 format and contain only characters existing in the GSM alphabet. It is also possible to send (abroad only) SMS in UCS-2, see parameter ucs2 for more details.
  • smslong string? - The long SMS allows you to exceed the limit of 160 characters by sending a message consisting of of several SMS. Up to 6 concatenated SMS can be sent for a maximum total length of 918 characters per message. For technical reasons, the limit per concatenated SMS is 153 characters. If the transmitter is changed, consider the automatic addition of 12 characters of the "STOP SMS". To send a smslong, you must add the smslong parameter to the calls. The value of SMS must be the maximum number of concatenated SMS allowed. In order not to have this error message and to obtain a dynamic calculation of the number of SMS then you must enter smslong = "999"
  • tracker string? - Le tracker doit être une chaine alphanumérique de moins de 50 caractères. Ce tracker sera ensuite renvoyé en paramètre des urls pour les retours des accusés de réception.
  • ucs2 string? - It is also possible to send SMS in non-Latin alphabet (Russian, Chinese, Arabic, etc.) on numbers outside mainland France. To do this, the request should be encoded in UTF-8 format and contain the argument ucs2 = "1" Due to technical constraints, 1 unique SMS cannot exceed 70 characters (instead of the usual 160) and in the case of long SMS, each SMS cannot exceed 67 characters.

isendpro: SubaccountAddRequest

Fields

isendpro: SubaccountAddResponse

Fields

isendpro: SubaccountaddresponseEtat

Fields

isendpro: SubaccountaddresponseEtatEtat

Fields

isendpro: SubaccountRequest

Fields
  • subAccountAddCredit string? - Amount of credit to add
  • subAccountCountryCode string? -
  • subAccountEdit string - Action to be carried out either setPrice to define a price or addCredit to add credit or setRestriction to modify the restriction stop.
  • subAccountKeyId string? - sub-account key ID
  • subAccountRestrictionStop string? -
  • subAccountRestrictionTime string? -

isendpro: SubaccountResponse

Fields

isendpro: SubaccountresponseEtat

Fields

isendpro: SubaccountresponseEtatEtat

Fields

Import

import ballerinax/isendpro;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Communication/Call & SMS

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC