Registrera avsändare

Innan du kan använda vårt API behöver du registrera en eller flera avsändare. Du kan ha så många avsändare du vill och du kan sedan avregistrera de du inte behöver.

För att du ska kunna använda din egen avsändare krävs ett av våra abonnemang, alternativt extratjänsten “Valfri Avsändare”, som köpes separat om du använder vårt system för SMS-saldo.

Obs! Om du utvecklar med av ett testkonto så behöver du använda avsändaren iP1 eller iP1sms.

Läs registrerade avsändare

Endpoint: GET me/senders

Denna endpoint listar alla dina registrerade avsändare som är knutna till ditt konto, sorterade i alfabetisk ordning.

Läs en enskild registrerad avsändare

Endpoint: GET me/senders/{sender}

Denna endpoint låter dig läsa en specifik avsändare.

Registrera en avsändare

Endpoint: PUT me/senders/{sender}

Denna endpoint tillåter dig att registrera en ny avsändare.

Avregistrera en avsändare

Endpoint: DELETE me/senders/{sender}

Den här endpointen låter dig avregistrera en avsändare. Outputen är densamma som vid registrering av avsändare

Du kan också registrera och ta bort avsändare via användarportalen

Responsdata-typ

{
    "sender": "TestNOS",
    "created": "2018-10-23T17:43:19Z"
}

sender

Den registrerade avsändaren.

created

Datumet då avsändaren registrerades

Kodexempel

Registrera avsändare C#

using (var client = new HttpClient())
{
    client.BaseAddress = new Uri("https://api.ip1sms.com/v2/");
    client.DefaultRequestHeaders.Accept.Clear();
    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "API Key");

    var sender = "iP1";

    HttpResponseMessage response = await client.PutAsync($"me/senders/{sender}", null);

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

Registrera avsändare PHP

$conf = array(
    'password' => 'API Key',
    'apiUrl' => 'api.ip1sms.com/v2/',
    'method' => 'PUT',
    'endpoint' => 'me/senders/',
);

$sender = "iP1";

// Set up request options
$options = array(
    'http' => array(
        'header'  => array(
            'Authorization: Bearer '.$conf['password']
        ),
        'method'  => $conf['method']
    )
);

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

Registrera avsändare VisualBasic

Imports System.Net.Http
Imports System.Net.Http.Headers

Module Module1
    Sub Main()
        Dim client As New HttpClient()

        client.BaseAddress = New Uri("https://api.ip1sms.com/v2/")
        client.DefaultRequestHeaders.Accept.Clear()
        client.DefaultRequestHeaders.Accept.Add(New MediaTypeWithQualityHeaderValue("application/json"))
        client.DefaultRequestHeaders.Authorization = New AuthenticationHeaderValue("Bearer", "API Key")

        Dim sender As String = "iP1"

        Dim response As HttpResponseMessage = client.PutAsync($"me/senders/{sender}", Nothing).Result

        If response.IsSuccessStatusCode Then
            Console.WriteLine("Sender registered")
        Else
            Console.WriteLine("Failed, " & response.StatusCode.ToString() & ": " & response.Content.ReadAsStringAsync().Result)
        End If
    End Sub
End Module