Integrera SMS med vårt moderna RESTful API

Utvecklar-site

RESTful SMS

Beskrivning

Här hittar du allt du behöver för att koppla vårt RESTful SMS API till ditt system eller applikation. Med hjälp av ett SMS API kan du enkelt skräddarsy dina egna SMS-funktioner. För mer detaljerad information, tryck på knappen Teknisk dokumentation.

kodexempel

Nedan hittar du kodexempel för att skicka SMS i olika programmeringsspråk. Det du behöver för att kunna anropa vårt API är ett kostnadsfritt utvecklingskonto, som du kan skapa genom att klicka på knappen nedan.

Skapa ett utvecklingskonto Teknisk dokumentation

      
    using (var client = new HttpClient())
    {
        client.BaseAddress = new Uri("https://api.ip1sms.com/api/");
        client.DefaultRequestHeaders.Accept.Clear();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes(string.Format("{0}:{1}", "ip1-xxxxx", "API-Key"))));

        var sms = new OutgoingSMS()
        {
            From = "iP1",
            Numbers = new List<string>() { "46123456789" },
            Contacts = new List<int>(),
            Groups = new List<int>(),
            Message = "test",
            Prio = 1,
            Email = false
        };

        HttpResponseMessage response = await client.PostAsJsonAsync("sms/send", sms);

        if (response.IsSuccessStatusCode)
        {
            Console.WriteLine("Sent");
        }
        else
        {
            Console.WriteLine("Failed, " + response.StatusCode + ": " + await response.Content.ReadAsStringAsync());
        }
    }

      
    $conf = array(
        'account' => 'ip1-xxxxx',
        'password' => 'apiKey',
        'apiUrl' => 'api.ip1sms.com',
        'method' => 'POST',
        'endpoint' => '/api/sms/send',
    );

    $message = array(
        'Numbers' => ['4673055555'],
        'From' => 'iP.1',
        'Message' => "Test message via iP.1's REST API",
    );

    $jsonEncodedMessage = json_encode($message);
    // Set up request options
    $options = array(
        'http' => array(
            'header'  => array(
                'Content-Type: application/json',
                'Authorization: Basic '. base64_encode($conf['account'].":".$conf['password']),
                'Content-Length: ' . strlen($jsonEncodedMessage)
            ),
            'method'  => $conf['method'],
            'content' => $jsonEncodedMessage,
        )
    );

    $url = "https://" . $conf['apiUrl'] . $conf['endpoint'];
    $context  = stream_context_create($options);
    // Send the request
    $response = file_get_contents($url, false, $context);
    // Print the response
    echo $response;

      
    Dim account As String = "ip1-xxxxxx"
    Dim password As String = "API-Key"

    Dim client As New HttpClient()

    client.BaseAddress = New Uri("https://api.ip1sms.com/api/")
    client.DefaultRequestHeaders.Accept.Clear()
    client.DefaultRequestHeaders.Accept.Add(New MediaTypeWithQualityHeaderValue("application/json"))

    Dim authString As String = Convert.ToBase64String(Encoding.ASCII.GetBytes($"{account}:{password}"))
    client.DefaultRequestHeaders.Authorization = New AuthenticationHeaderValue("Basic", authString)

    Dim sms As New With
        {
            Key .From = "iP1sms",
            Key .Numbers = New List(Of String)() From {"46123456789"},
            Key .Contacts = New List(Of Integer)(),
            Key .Groups = New List(Of Integer)(),
            Key .Message = "Test", Key .Email = False
        }

    Dim response As HttpResponseMessage = Await client.PostAsJsonAsync("sms/send", sms)


    End Sub`;

RESTful Surveys

Beskrivning

Här hittar du allt du behöver för att koppla vårt RESTful Survey API till ditt system eller applikation. Med hjälp av ett Survey API kan du enkelt skräddarsy dina egna automatiska kundundersökningar. För mer detaljerad information, tryck på knappen Teknisk dokumentation.

Kodexempel

Nedan hittar du ett enkelt kodexempel för att skicka en redan skapad enkät i olika programmeringsspråk. Det du behöver för att kunna anropa vårt API är ett kostnadsfritt utvecklingskonto, som du kan skapa genom att klicka på knappen nedan. Du kan enkelt skapa en enkät väl inloggad i appen Analys-SMS eller genom API-anrop.

Skapa ett utvecklingskonto Teknisk dokumentation

      
    using (var client = new HttpClient())
    {
        client.BaseAddress = new Uri("https://api.ip1sms.com/api/");
        client.DefaultRequestHeaders.Accept.Clear();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes(string.Format("{0}:{1}", "ip1-xxxxx", "API-Key"))));

        var survey = new OutgoingSurvey()
        {
            From = "iP1",
            Numbers = new List<string>() { "46123456789" },
            Contacts = new List<int>(),
            Groups = new List<int>(),
            Message = "test survey",
            Prio = 1,
            Email = false
        };

        HttpResponseMessage response = await client.PostAsJsonAsync("surveys/{survey}/send", survey);

        if (response.IsSuccessStatusCode)
        {
            Console.WriteLine("Survey Sent");
        }
        else
        {
            Console.WriteLine("Failed, " + response.StatusCode + ": " + await response.Content.ReadAsStringAsync());
        }
    }

      
    $conf = array(
        'account' => 'ip1-xxxxx',
        'password' => 'apiKey',
        'apiUrl' => 'api.ip1sms.com',
        'method' => 'POST',
        'endpoint' => '/surveys/{survey}/send',
    );

    $message = array(
        'Numbers' => ['4673055555'],
        'From' => 'iP.1',
        'Message' => "Test message via iP.1's REST API",
    );

    $jsonEncodedMessage = json_encode($message);
    // Set up request options
    $options = array(
        'http' => array(
            'header'  => array(
                'Content-Type: application/json',
                'Authorization: Basic '. base64_encode($conf['account'].":".$conf['password']),
                'Content-Length: ' . strlen($jsonEncodedMessage)
            ),
            'method'  => $conf['method'],
            'content' => $jsonEncodedMessage,
        )
    );

    $url = "https://" . $conf['apiUrl'] . $conf['endpoint'];
    $context  = stream_context_create($options);
    // Send the request
    $response = file_get_contents($url, false, $context);
    // Print the response
    echo $response;

      
    Dim account As String = "ip1-xxxxxx"
    Dim password As String = "API-Key"

    Dim client As New HttpClient()

    client.BaseAddress = New Uri("https://api.ip1sms.com/api/")
    client.DefaultRequestHeaders.Accept.Clear()
    client.DefaultRequestHeaders.Accept.Add(New MediaTypeWithQualityHeaderValue("application/json"))

    Dim authString As String = Convert.ToBase64String(Encoding.ASCII.GetBytes($"{account}:{password}"))
    client.DefaultRequestHeaders.Authorization = New AuthenticationHeaderValue("Basic", authString)

    Dim survey As New With
        {
            Key .From = "iP1sms",
            Key .Numbers = New List(Of String)() From {"46123456789"},
            Key .Contacts = New List(Of Integer)(),
            Key .Groups = New List(Of Integer)(),
            Key .Message = "Test", Key .Email = False
        }

    Dim response As HttpResponseMessage = Await client.PostAsJsonAsync("surveys/{survey}/send", survey)


    End Sub`;

RESTful 2FA

Beskrivning

Genom att koppla på 2FA vid exempelvis registrering av nya konton kan du enkelt säkerställa att personen har angivit rätt uppgifter genom att bekräfta användarens telefonummer. Koden skickas som ett SMS till angivet nummer på nolltid.

När du integrerar tvåfaktorsautentisering via SMS från iP.1 får du automatisk tillgång till vår globala spamfilterlista som innehåller tusentals virtuella nummer som använts vid illasinnade bot-registreringar.

Kodexempel

Nedan hittar du kodexempel för att Skapa/skicka autentisering samt validera, i olika programmeringsspråk. Det du behöver för att kunna anropa vårt API är ett kostnadsfritt utvecklingskonto, som du kan skapa genom att klicka på knappen nedan.

Skapa ett utvecklingskonto Teknisk dokumentation

    
    $conf = array(
        'account' => 'ip1-XXXXX',
        'password' => 'APIKey',
        'apiUrl' => 'api.ip1sms.com',
        'endpoint' => '/api/authentications',
        'method' => 'POST'
        );
        
    $message = array(
        'Phone' => '46712345678',
        'From' => 'iP1sms',
        'MessageFormat' => 'Använd denna kod för att verifiera: {0}',
        'Length' => '6',
        'ExpirationTime' => '1200'
    );

    $jsonEncodedMessage = json_encode($message);


    $options = array(
        'http' => array(
            'header'  => array(
                'Content-Type: application/json',
                'Authorization: Basic '. base64_encode($conf['account'].":".$conf['password']),
                'Content-Length: ' . strlen($jsonEncodedMessage)
            ),
            'method'  => $conf['method'],
            'content' => $jsonEncodedMessage,
        )
    );

    $Url = "https://" . $conf['apiUrl'] . $conf['endpoint'];
    $context  = stream_context_create($options);

    $response = file_get_contents($SendUrl, false, $context);

    echo $response;

    
    $submittedCode = $_POST["code"]; // e. g. 453342

    $conf = array(
        'account' => 'ip1-XXXXX',
        'password' => 'APIKey',
        'apiUrl' => 'api.ip1sms.com',
        'endpoint' => '/api/authentications/validate',
        'method' => 'POST'
        );

    $validate = array(
        'Phone' => '46712345678',
        'Code' => $submittedCode
    );

    $jsonEncodedValidation = json_encode($validate);

    $options = array(
        'http' => array(
            'header'  => array(
                'Content-Type: application/json',
                'Authorization: Basic '. base64_encode($conf['account'].":".$conf['password']),
                'Content-Length: ' . strlen($jsonEncodedValidation)
            ),
            'method'  => $conf['method'],
            'content' => $jsonEncodedValidation,
        )
    );

    $ValidationUrl = "https://" . $conf['apiUrl'] . $conf['endpoint'];
    $context  = stream_context_create($options);

    $response = file_get_contents($ValidationUrl, false, $context);

    echo $response;

C#

Skapa & skicka autentisering
Validera autentisering

    
    using (var client = new HttpClient())
    {
        client.BaseAddress = new Uri("http://api.ip1sms.com/api/");
        client.DefaultRequestHeaders.Accept.Clear();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes(string.Format("{0}:{1}", "ip1-xxxxx", "API-Key"))));

        var authentication = new AuthenticationDTO()
        {
            Phone = "46712345678",
            From = "iP1sms",
            MessageFormat = "Använd {0} för att verifiera dig",
            Length = "6"
            ExpirationTime = "1200"
        };

        HttpResponseMessage response = await client.PostAsJsonAsync("authentications", authentication);

        if (response.IsSuccessStatusCode)
        {
            Console.WriteLine("Sent");
        }
        else
        {
            Console.WriteLine("Failed, " + response.StatusCode + ": " + await response.Content.ReadAsStringAsync());
        }
    }

    
    string submittedCode = Console.ReadLine(); // e. g. 453342

    using (var client = new HttpClient())
    {
        client.BaseAddress = new Uri("http://api.ip1sms.com/api/");
        client.DefaultRequestHeaders.Accept.Clear();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes(string.Format("{0}:{1}", "ip1-xxxxx", "API-Key"))));

        var validation = new AuthenticationValidationRequest()
        {
            Phone = "46712345678",
            Code = submittedCode,
        };

        HttpResponseMessage response = await client.PostAsJsonAsync("authentications/validate", validation);

        if (response.IsSuccessStatusCode)
        {
            Console.Log("Validated");
        }
        else
        {
            Console.Log("Failed, " + response.StatusCode + ": " + await response.Content.ReadAsStringAsync());
        }
    }

SMS Gateway (Soap) Deprecated

Kodexempel

OBS! API:et är deprekerat och kommer inte längre att vidareutvecklas. Vi rekommenderar er att använda något av våra REST API:er
Nedan hittar du kodexempel för skicka ett SMS med vår HTTP SMS Gateway i PHP. Det du behöver för att kunna anropa vårt SMS Gateway är ett kostnadsfritt utvecklingskonto, som du kan skapa genom att klicka på knappen nedan.

Skapa ett utvecklingskonto

    
    $conf['apiurl'] = 'https://web.smscom.se/sendsms/sendsms.asmx?wsdl';
    $conf['mmsapiurl'] = 'https://web.smscom.se/mms/mms.asmx?wsdl';
    $conf['account'] = 'ip1-xxxxx';  
    $conf['password'] = 'API-Key'; 
    
    $conf['to'] = '46712345678'; 
    $conf['from'] = 'iP1';
    $conf['prio'] = '1';
    $conf['msg'] = 'Test message via iP.1 API (Web Service)';
    $conf['msg_at'] = "Test send at message via iP.1 API (Web Service)";
    $conf['msg_bundle'] = "Test bundle message via iP.1 API (Web Service)";

    $client = new SoapClient($conf['apiurl']);
    $mmsClient = new SoapClient($conf['mmsapiurl']);

    $result = $client->balans(array('konto'=>$conf['account'], 'passwd' => $conf['password']));
    echo 'Balnace: ' . $result->balansResult;

    $smsresult = $client->sms(array('konto'=>$conf['account'], 'passwd' => $conf['password'], 'till' => $conf['to'], 'from' => $conf['from'], 'meddelande' =>$conf['msg'], 'prio' => $conf['prio']));

    echo 'Result of SMS: ' . $smsresult->smsResult;

SMS Gateway (http) Deprecated

Kodexempel

Skapa ett utvecklingskonto

    
    $conf['account'] = 'ip1-xxxx';  
    $conf['password'] = 'api-key'; 
    $conf['apiurl'] = 'https://web.smscom.se/sendsms.aspx';
    
    $conf['to'] = '4673055555';     
    $conf['from'] = 'iP.1';        
    $conf['msg'] = 'Test message via iP.1 HTTP Request';       
    $conf['prio'] = '1';

    $data = http_build_query(array('acc'=>$conf['account'],'pass'=>$conf['password'],'msg'=>  $conf['msg'],'from'=>$conf['from'],'to'=> $conf['to'],'prio'=>$conf['prio'], 'type' => ''));
            
    
    $opts = array('http' =>
        array(
            'method'  => 'GET',
            'header'  => 'Content-type: application/x-www-form-urlencoded',
            'content' => $data
        )
    );
    
    $context  = stream_context_create($opts);            
    $result = file_get_contents($conf['apiurl'] . '?' . $data, false, $context);
    
    echo 'Result/SMS ID: ' . $result;

Statuskoder SMS

Nedan hittar du en lista över alla SMS statuskoder samt beskrivning för varje kod. Om du använder flertalet av våra API:er med samma API-nyckel behöver du lägga till stöd för statuskoderna i alla använda API:er.

Statuskoder

Statuskod	Meddelande	Beskrivning	Försök igen med samma data?	Applicerbart API
0	Delivered to gateway	Meddelanden har nått Gateway och bör betraktas som "Under behandling".	Nej (Slutdestination ännu inte nådd)	REST, SOAP, Gateway
1	Gateway login failed	Misslyckades att logga in på gateway.	Ja, senare	SOAP, Gateway
3	Invalid number format	Ogiltigt nummerformat.	Nej	SOAP, Gateway
11	Delayed delivery	Tidsinställt Meddelande, kommer att skickas i framtiden.	Nej (Slutdestination ännu inte nådd)	SOAP, Gateway
12	Delayed delivery cancelled	Tidsinställt SMS avbrutet av användaren.	Nej	SOAP, Gateway
21	Delivered to the GSM network	Meddelandet bär ses som "under behandling" och kan komma att behålla statuses till mottagarens telefon finns tillgänglig på GSM-nätet eller tills 48 timmar har gått.	Nej (Slutdestination ännu inte nådd)	REST, SOAP, Gateway
22	Delivered to the phone	Meddelande har levererats utan problem.	Nej	REST, SOAP, Gateway
41	Invalid message content	Ogiltigt innehåll i meddelandet.	Nej	Ingen (Deprekerad)
42	Internal error	Internt fel. Vänligen kontakta supporten för mer info.	Ja	REST, SOAP, Gateway
44	Delivery failed	Mottagaren fanns inte tillgänglig på GSM nätverket under SMS:ets livsspann (48 Timmar).	Ja	Ingen (Deprekerad)
50	General delivery error	Generellt leveransfel.	Nej	SOAP, Gateway
51	Delivery to GSM network failed	Ett radiontorn misslyckade att leverera meddelandet/Mottagaren fanns inte tillgänglig på GSM nätverket under SMS:ets livslängd (48 Timmar).	Ja	REST, SOAP, Gateway
52	Delivery to phone failed	Mottagaren fanns inte tillgänglig på GSM-nätet under meddelandets livslängd (48 timmar).	Yes	REST, SOAP, Gateway
55	Unknown		No	Ingen (Deprecated)
60	Unknown		No	Ingen (Deprecated)
100	Insufficient credits	Otillräckligt med SMS-saldo för att kunna utföra utskicket.	Refill credits first	SOAP, Gateway
101	Wrong account credentials	Ogiltiga kontouppgifter.	No	SOAP, Gateway
110	Parameter error		No	SOAP, Gateway