Create a sender

This method allow you to send a new sender request.

Some countries require you to register a sender before you can send an SMS with a personalised sender. Here is the list of countries concerned:

Each registration request is processed by our customer service department.

POST

/sender

Body Parameters

sender
required
 Your sender
country_code
required
 Country where you will use this sender (ISO 3166-1 alpha-2)
company_name
required
 Your company
general_contact
required
 Your email contact
phone_number
required
 Your contact phone
vat Your VAT number
fiscal_code Your fiscal code
complete_address Your company address
escalation_contact Your PEC address
website Your website
type_of_service Your business activity
type_of_sms In some country, the content of SMS is needed

Examples


POST /sender HTTP/1.1
Host: api.smsup.ch
Authorization: Bearer your.token
Accept: application/json

{
    "sender": {
    "sender": "MySender",
    "country_code": "FR",
    "company_name": "My company",
    "vat": "FR123456789",
    "fiscal_code": "FR123456789",
    "complete_address": "1 rue de la paix",
    "escalation_contact": "email@domain.com",
    "general_contact": "email@domain.com",
    "website": "www.domain.com",
    "type_of_service": "services",
    "phone_number": "41781234567",
    "message_type": "My SMS content"
    }
}

Result Format


{
    "status": 1,
    "message": "OK",
    "sender": {
        "id": 7,
        "sender": "MySender",
        "country_code": "FR",
        "status": "0",                    //Status of the sender request
        "company_name": "My company",
        "vat_number": "FR123456789",
        "fiscal_code": "FR123456789",
        "full_address": "1 rue de la paix",
        "escalation_contact": "email@domain.com",
        "general_contact": "email@domain.com",
        "website": "www.domain.com",
        "type_of_service": "services",
        "phone_number": "41781234567",
        "created_at": "2024-11-21 09:02:05",
        "message_type": "My SMS content"
    }
}
                    
                  

<response>
<status>1</status>
<message>OK</message>
<sender>
    <id>7</id>
    <sender>MySender</sender>
    <country_code>FR</country_code>
    <status>0</status>
    <company_name>My company</company_name>
    <vat_number>FR123456789</vat_number>
    <fiscal_code>FR123456789</fiscal_code>
    <full_address>1 rue de la paix</full_address>
    <escalation_contact>email@domain.com</escalation_contact>
    <general_contact>email@domain.com</general_contact>
    <website>www.domain.com</website>
    <type_of_service>services</type_of_service>
    <phone_number>41781234567</phone_number>
    <created_at>2024-11-21 09:02:05</created_at>
    <message_type>My SMS content</message_type>
</sender>
</response>

Statuses

Code Value
-1 Request rejected
0 Request in progress
1 Request made to the operator
2 Request validated
3 Request cancelled