HTTPS API v2 / Managing names of the sender

FULL SMS messages allow you to use your own text or number in the SMS header (installed on the SerwerSMS.pl platform). Due to legal changes, the use of your sender's name as a text (eg company name) requires additional authorization. At any time, you can list the name of the sender added to the system and check their authorization status.

Adding the names of the sender

Calling address

 

For using the remote operating to report the new name for authentication, call the specified URL using the POST method.

senders/add

Available parameters

Parameter	Type	An example value or format	Description
username	String	Login	Username to the account
password	String	Password	Password to the account
name	String	Competition, SerwerSMSpl	The alphanumeric sender's name (max 11 characters).

The parameters in bold are obligatory. Others are optional.

Return response

{
   "success":true
}

Listing the names of the sender and their status

Calling address

For using the remote operating send a text message should be sent to specific application protocol HTTP or HTTPS POST method.

senders/index

Available parameters

Parameter	Type	Przykładowa wartość lub format	Description
username	String	Login	Username to the account
password	String	Haslo	Password to the account
predefined	Boolean	true, false or none	An optional parameter allows display predefined in the system name of the sender ready to use in dispatch SMS.
type	String	ndi|mms	Optional parameter displaying the list of NDI or MMS senders.
sort	String	name	An optional parameter that allows sorting by sender name.
order	String	asc|desc	An optional parameter you can change the sort order.

The parameters in bold are obligatory. Others are optional.

Return response

{
   "items":[{
      "name":"Testowa",
      "agreement":"not_required",
      "status":"pending_authorization"
   },
   {
      "name":"SerwerSMSpl",
      "agreement":"delivered",
      "status":"authorized"
   },
   {
      "name":"+48783820099",
      "agreement":"not_required",
      "status":"authorized"
   },
   {
      "name":"T-mobile",
      "agreement":"required",
      "status":"rejected",
      "note":"Używanie nazw własnych Operatorow GSM jest zabronione"
   }]
}

Explanation of individual parameters feedback

Parameter	Description
name	Specifies what name or number is processed.
agreement	Indicates whether the name requires special permission to use her. Accepted values: delivered, required, not_required.
status	Whether the name is approved and ready for dispatch. Values: pending_authorization, authorized, rejected, deactivated.
note	The message in the event of an error.
networks	Attribute available for the list of MMS senders. Specifies for which operators the override is active.

Recommended settings

It is possible to receive automatic information on the sender's name approval or other name change by pressing the Push method. These settings should be specified in the Customer Panel → Message settings → Sender's names → Additional settings.

The successful addition of the sender's name to the SerwerSMS.pl system does not mean that it can be used when sending messages. Each sender's name must be verified by the SMS.pl server administrator and only after the name has been accepted and its status changed, it is possible to send a shipment using it. In certain cases, the name may be rejected by the administrator as incorrect or restricted. It is possible to suspend activation of the sender's name until it is approved for its use by the customer.