Registrera avsändare
Förutsättningar
För att du ska kunna använda din egen avsändare behöver du registrera den på ditt konto. Detta kan du göra via anrop till API:et som beskrivs nedan, eller via direkt via användarportalen.
Observera att dina registrerade avsändare enbart går att skicka med om du har ett aktivt abonnemang, alternativt extratjänsten “Valfri Avsändare”, som köpes separat om du använder vårt system för SMS-saldo. Denna går att beställa i någon av våra webbtjänster eller i webshoppen
Obs! Om du utvecklar med ett testkonto så behöver du använda avsändaren iP1 eller iP1sms. Dessa avsändare finns registrerade initialt på kontot.
Quick start
Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen.
curl -X PUT "https://api.ip1sms.com/v2/me/senders" \
-H "Authorization: Bearer API_NYCKEL" \
-H "Content-Type: application/json" \
-d '{
"sender": "Foretagsnamn"
}'
Anrop
Registrera avsändare
Endpoint: me/senders/{sender}
Metod: PUT
Läs avsändare
Endpoint: me/senders
Metod: GET
Läs en enskild avsändare
Endpoint: me/senders/{sender}
Metod: GET
Avregistrera avsändare
Endpoint: me/senders/{sender}
Metod: DELETE
Exempel på anropsdata
{
"sender": "TestNOS"
}
Fält för anropsdata
| Fältnamn | Obligatoriskt | Typ | Beskrivning och Villkor | Exempel |
|---|---|---|---|---|
| sender | Ja | String |
Ett Anrop kommer att avslås om sender:
|
|
Respons
Exempel på responsdata
{
"sender": "TestNOS",
"created": "2018-10-23T17:43:19Z"
}
Fält för responsdata
| Fältnamn | Typ | Beskrivning och Villkor | Exempel |
|---|---|---|---|
| sender | String |
Den registrerade avsändaren. |
|
| created | String |
Datum/tidsstämpel 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