API Documentation

Ta emot leveransrapporter Om en URL för leveransrapporter har angets när en batch skapas, kommer rapporter över statusuppdateringar att skickas till den URL så fort de finns tillgängliga. Innehållet i dessa rapporter är beskrivna nedan. Systemet skickar ut rapporter genom metoden POST och förväntar sig ett 200 OK i respons om rapporten tagits emot korrekt. Om någon respons består […]

Status Codes Summary This is a summary of what each status code group means. The way our status blocks work is that if, for example, the code starts with 1, the status belongs to the status group Info. This allows us to add new status codes while your software can still handle these new status codes without being explicitly developed for […]

Verifiera e-postdomäner En registrerad domän måste verifieras innan den används för att säkerställa leverans av e-post och ägande av domänen. Verifiering görs genom att lägga till specifika DNS-poster i domänens namnserver. Kontrollera verifieringsstatus/instruktioner Endpoint: GET domains/{domain}/verification Denna slutpunkt returnerar verifieringsstatusen för domänen. Om verifieringsstatusen är falsk kommer nästa saknade/krävda DNS-poster att tillhandahållas. Respons-datatyp domain Domänen […]

Registrera e-postdomäner för utskick Innan du skickar e-postmeddelanden med våra API:er måste du registrera sändningsdomänen som du ska använda. Du kan registrera hur många domäner du vill och du kan avregistrera de som du inte använder längre. Detta kan du även göra via användarportalen. Dessutom måste registrerade domäner verifieras för att säkerställa leverans av e-postmeddelanden […]

E-postbatcher – En grupp av e-postmeddelanden Läsa en samling av e-postbatcher Endpoint: GET emails Den här endpointen ger dig en samling e-postbatcher för vilka du kan se e-post dokument-definitionen nedan. MessageSummary och PriceSummary kommer dock inte att tillhandahållas eftersom de endast är tillgängliga för den endpointen för enskilda meddelanden i en e-postbatch. Ordnad kronologiskt efter […]

Läs meddelanden När du läser meddelanden är det alltid i ett e-postsammanhang. Ett meddelande kan inte existera utan ett e-post och därför placeras meddelanden under e-postmeddelanden hierarkiskt. Läs en samling av meddelanden Endpoint: GET emails/{email}/messages Denna endpoint kommer att förse dig med dokumenten för alla meddelanden i ett e-postmeddelande med deras senaste leveransrapport som respons-datatypen […]

Skicka e-post Endpoint Endpoint: POST emails När du vill skicka e-postmeddelanden använder du dig av anrops-datatypen nedan. Anrops-datatyp I sin kärna behöver endpointen för e-postustkick följande värden: Detta anrop kommer att omgående att skicka ett e-postmeddelande till varje angiven mottagare med textinnehållet ”Detta är ett enkelt testmeddelande” till med avsändaren ”iP.1 Networks AB”. senderName Namnet […]

Introduktion till iP.1 e-mail API iP.1 e-mail API låter dig ansluta dina webbplatser och applikationer till e-postklienter över hela världen. Kom igång För att använda våra API:er behöver du först registrera ett konto. Detta kan du göra genom att besöka vår webshop. Registrera ett kostnadsfritt testkonto. När du skapat ditt konto loggar du in i […]

Uppdatera underkonto Uppdatera ett enskilt underkonto Endpoint Endpoint: PUT /api/me/children/{child} Denna endpoint låter dig uppdatera ett enskilt underkonto kopplat till ett konto. Anropsadata-typ ID Ett enskilt underkontons unika konto-ID Name Ett enskilt underkontos märkning eller namn. Responsdata-typ Key Ett enskilt underkontots API-nyckel. Parent Ett enskilt underkontos föräldra-konto. Type Ett enskilt underkontos konto-typ. Balance Ett enskilt underkontos […]

Lista underkonton Lista samtliga underkonton Endpoint Endpoint: GET /api/me/children Denna endpoint låter dig lista samtliga underkonton kopplade till ett konto. Lista enskilt underkonto Endpoint Endpoint: GET /api/me/children{child} Denna endpoint låter dig lista ett enskilt underkonto kopplade till ett konto. Responsdata-typ Key Ett enskilt underkontos API-nyckel. Parent Ett enskilt underkontos föräldra-konto. Type Ett enskilt underkontos kontotyp. Balance Ett […]

Skapa underkonto Skapa ett nytt underkonto Endpoint Endpoint: POST /api/me/children Denna endpoint låter dig skapa ett nytt underkonto, underordnat ditt huvudkonto. Anropsdata-typ Name Kontots märkning. Exempelvis avdelningsnamn eller annat namn som anspelar på kontots syfte. Responsdata-typ Key Ett underkontots API-nyckel. Parent Ett underkontos föräldra-konto. Type Ett underkontos konto-typ. Balance Ett underkontos saldonivå. Kan bestå av en […]

Detaljer konto Hämta detaljer för underkonto Endpoint Endpoint: GET /api/me/account Denna endpoint ger dig en detaljlista för ett enskilt konto enligt responsdata-typen nedan. Responsdata-typ Key Ett enskilt kontos API-nyckel. Parent Ett enskilt kontos föräldra-konto. Type Ett enskilt kontos kontotyp. Balance Ett enskilt kontos saldonivå. Kan bestå av en negativ siffra eller positiv siffra beroende på vilken […]

Överblick konton Endpoint Endpoint: GET /api/me Denna endpoint ger dig överblick över ditt huvudkonto konto, Responsdata-typ Account Ett enskilt kontos unika ID bestående av prefixet ip1- följt av ett antal siffror. Organization Företagets/organisations namn som står som ägare till kontot. Type ett enskilt kontos kontotyp, swedish eller international. Konton av typ swedish är enbart lämpat för SMS-trafik inom Sverige. All trafik utanför […]

Manage page elements Reading a collection of landing page elements Endpoint: GET v2/landings/{landingId}/elements This endpoint gives you a collection of the elements on a specific landing page. See data type definition below. Read a specific element Endpoint: GET v2/landings/{landingId}/elements/{elementId} This endpoint gives you a specific element on a landing page Update an element Endpoint: PUT v2/landings/{landingId}/elements/{elementId} This endpoint lets […]

Manage landing pages Read a collection of landing pages Endpoint: GET v2/landings This endpoint provides you with a collection of landing pages for which you can see the data type definition below. Read a single landing page Endpoint: GET v2/landings/{landingId} This endpoint gives you a single specific landing page. Update a landing page Endpoint: PUT v2/landings/{landingId} This endpoint allows you to update a specific landing page, […]

Summary Contacts Endpoint: GET v2/contacts/meta This endpoint provides a summary of the contact data stored in the contact system Response Data Type totalCount The total number of contacts stored. labels An entry for each label used. labels.labelName The name of the label labels.usageCount The number of stored contacts assigned to the label properties One record for each property used. properties.propertyName The name/key of the property. properties.usageCount The number of […]

Status Codes Summary This is a summary of what each status code group means. The way our status blocks work is that if, for example, the code starts with 1, the status belongs to the status group Info. This allows us to add new status codes while your software can still handle these new status codes without being explicitly developed for […]

Manage labels These endpoints update all contacts in the perspective from a label and return a summary of the label in question. Add a label for multiple contacts Endpoint: POST /v2/labels/{labelName}/contacts This endpoint allows you to add a label to many contacts at once. It takes a collection of Contact IDs Example Input: Delete a label Endpoint: DELETE /v2/labels/{labelName} […]

Manage contacts Read a collection of contacts Endpoint: GET contacts This endpoint gives you a collection of contacts for which you can see the definition of the contacts document below. This collection can be filtered by properties, metadata and/or labels using query parameters. Metadata is only available if meta is added as a query parameter. Examples of filters Read a single […]

Mass operations These endpoints perform so-called mass operations and can sometimes be destructive or "dangerous" as data can disappear if it is not used correctly. Delete contacts by filtering Endpoint: DELETE v2/contacts This endpoint allows you to delete all contacts that match the applied filters. These are the same filters as for listing contacts (see […]

Manage settings Each account can have a number of settings for SMS services. These can be managed with the endpoints below. After endpoints is a list of available settings and their data types. When you set a preference, it is either created or replaced, depending on whether it has been previously set. A removed setting either reverts to a global […]

Send SMS Endpoint Endpoint: POST /v2/batches Send one or more SMS Call data type At its core, the endpoint for Send SMS needs the following values: These values will directly send a message to each recipient with the message text "A very nice message ". The sender of the message will be "Testnos" sender A Call will be rejected if Sender: […]

Register senders Before you can use our API, you need to register one or more senders. You can have as many senders as you want and you can then unregister the ones you don't need. In order for you to be able to use your own sender, one of our subscriptions is required, alternatively the extra service "Any Sender", which is purchased separately if you [...]

Receive incoming SMS If an incoming SMS callback URL is specified in the account settings, incoming SMS messages will be sent to that URL when available. The content of these SMS messages is described below. Our system sends incoming SMS using POST and expects a 200 OK response if the SMS is delivered correctly. If any other status (ie an error status) is received, the [...]

Receive Delivery Reports If a delivery report URL has been specified when a batch is created, status update reports will be sent to that URL as soon as they are available. The contents of these reports are described below. The system sends out reports through the POST method and expects a 200 OK response if the report has been received correctly. If any the response consists […]

List Messages When you list messages, it is always in the context of a batch. A message cannot exist outside of a batch, therefore a message is always placed hierarchically subordinate to a batch. List a collection of messages Endpoint: GET /v2/batches/{batch}/messages This endpoint provides you with all messages in a batch with latest associated delivery reports according […]

Conversations Read messages or a summary of messages related to specific participants. This may, for example, involve conversations between you and a specific customer. Messages Read messages to and/or from a provided participant. The returned data is a paginated list of the same type shown in the List Messages section. Sorted chronologically by creation date. mt is […]

Manage Blacklist Your account has a blacklist of phone numbers that have somehow been blocked from receiving SMS. This can be done by using these APIs or by the recipient responding with 'STOP' or using the extra service 'unsubscribe link'. Response data type msisdn The blocked mobile number in MSISDN format. created A timestamp of when the number was added [...]

Batch - Grouping of messages List a collection of batches Endpoint: GET /v2/batches This endpoint will give you a collection of batches, as defined by batch below. Note that messageSummary and priceSummary are only available in the endpoint for individual batches. Batches are listed in chronological order by the date they were created. List a single Batch Endpoint: GET […]

Introduction RESTful APIs from iP.1 Get started Our SMS API allows you to connect your web services and applications to mobile operators worldwide and is designed to handle high volumes of SMS traffic and is perfectly suited for, among other things, larger group mailings in e.g. marketing , but also single mailings for automated SMS alerts etc. Create an account For […]

API:er från iP.1 Vi på iP.1 tycker att det ska vara enkelt att utveckla och har fullständig dokumentation över samtliga våra API:er. Välj ovan vilket API du vill implementera genom att klicka på respektive ruta. Upptäck möjligheterna med våra API:er Genom att ladda ner vår demo-app kan du gå en rundtur i våra API:er för […]