API Documentation

Receiving 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 content of these reports is described below. The system sends out reports using the POST method and expects a 200 OK response if the report was received correctly. If any response consists [...]

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 […]

Verifying email domains A registered domain must be verified before it is used to ensure email delivery and ownership of the domain. Verification is done by adding specific DNS records to the domain name server. Check verification status/instructions Endpoint: GET domains/{domain}/verification This endpoint returns the verification status of the domain. If the verification status is false, the next missing/required DNS records will be provided. Response data type domain The domain [...]

Registering email domains for sending Before sending emails using our APIs, you need to register the sending domain you will use. You can register as many domains as you want and you can unregister those you no longer use. You can also do this via the user portal. In addition, registered domains need to be verified to ensure delivery of emails [...]

Email batches - A group of emails Reading a collection of email batches Endpoint: GET emails This endpoint provides you with a collection of email batches for which you can see the email document definition below. However, MessageSummary and PriceSummary will not be provided as they are only available to that endpoint for individual messages in an email batch. Arranged chronologically by [...]

Read messages When you read messages, it is always in an email context. A message cannot exist without an email and therefore messages are placed under emails hierarchically. Read a collection of messages Endpoint: GET emails/{email}/messages This endpoint will provide you with the documents of all messages in an email with their latest delivery report as the response data type

Send emails Endpoint Endpoint: POST emails To send emails, use the calls data type below. Call Data Type At its core, the email send endpoint needs the following values: This call will immediately send an email to each specified recipient with the text content ”This is a simple test message” to with the sender ”iP.1 Networks AB”. senderName The name [...]

Introduction to the iP.1 email API The iP.1 email API allows you to connect your websites and applications to email clients worldwide. Getting started To use our APIs, you first need to register an account. You can do this by visiting our webshop. Register a free trial account. Once you have created your account, log in to [...]

Update sub-account Update a single sub-account Endpoint Endpoint: PUT /api/me/children/{child} This endpoint allows you to update a single sub-account associated with an account. Call Data Type ID An individual sub-account's unique account ID Name An individual sub-account's label or name. Response data type Key An individual sub-account's API key. Parent The parent account of an individual sub-account. Type The account type of an individual sub-account. Balance An individual sub-account's [...].

List subaccounts List all subaccounts Endpoint Endpoint: GET /api/me/children This endpoint allows you to list all subaccounts associated with an account. List single sub-account Endpoint Endpoint: GET /api/me/children{child} This endpoint allows you to list a single sub-account associated with an account. Response Data Type Key The API key of an individual sub-account. Parent The parent account of an individual sub-account. Type An individual sub-account's account type. Balance An [...]

Create sub-account Create a new sub-account Endpoint Endpoint: POST /api/me/children This endpoint allows you to create a new sub-account, subordinate to your main account. Call data type Name The account label. For example, department name or other name that alludes to the purpose of the account. Response data type Key A sub-account's API key. Parent The parent account of a sub-account. Type The account type of a sub-account. Balance A sub-account's balance level. May consist of a [...].

Details account Get details for sub-account Endpoint Endpoint: GET /api/me/account This endpoint gives you a detail list for an individual account according to the response data type below. Response Data Type Key An individual account's API key. Parent The parent account of an individual account. Type An individual account's account type. Balance The balance level of an individual account. Can be a negative number or a positive number depending on which [...].

Account overview Endpoint Endpoint: GET /api/me This endpoint gives you an overview of your main account Account, Response data type Account An individual account's unique ID consisting of the prefix ip1- followed by a number of digits. Organization The name of the company/organization that is the owner of the account. Type of an individual account's account type, swedish or international. Accounts of type swedish are only suitable for SMS traffic within Sweden. All traffic outside [...]

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 Quick start Use the example below and replace “API_NYCKEL” with a bearer token that you create in the user portal Call Endpoint: v2/contacts/meta Method: GET This endpoint provides a summary of the contact data stored in the contact system Example call Response Example response data Fields for response data Field name Type Description Example totalCount Integer The [...]

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 […]

Sending SMS Quick start Use the example below and replace ”API_NYCKEL” with a bearer token that you create in the user portal. Call Endpoint: /v2/batches Method: POST Content-Type: application/json Call data example The example above contains the call data with the mandatory sender, recipients and body fields, required to send an SMS message. See under the heading Call data fields [...]

Registering a sender Prerequisites In order to use your own sender, you need to register it in your account. You can do this by calling the API described below, or directly via the user portal. Please note that your registered senders can only be sent with if you have an active subscription, or the extra service ”Optional Sender”, [...]

Receive incoming SMS Prerequisites To be able to receive incoming to our system and then forward them to your callback URL, a virtual number is needed. You can easily get a virtual number by ordering one of our subscriptions, or order the extra service 11-digit virtual number in our webshop. Description If a callback URL [...]

Receive delivery reports Description 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 content of these reports is described below. The system sends out reports using the POST method and expects a 200 OK response if the report was received correctly. If any response [...]

List Messages Prerequisites 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. Quick start Use the example below and replace “API_NYCKEL” with a bearer token that you create in the user portal, and {batchId} with a [...]

Conversations Read messages to and/or from a provided participant. Quick start Using the example below, replace “API_NYCKEL” with a bearer token that you create in the user portal and replace {participant} with a number in the format MSISDN (46712345678) Call Retrieve all messages This endpoint allows you to retrieve all messages in a conversation, regardless of direction, based on [...]

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 [...]

Batcher Quick start Use the example below and replace “API_NYCKEL” with a bearer token that you create in the user portal. Call List a collection of batches Endpoint: /v2/batches Method: GET List a single Batch Endpoint: /v2/batches/{batchId} Method: GET Call example Call data fields Field name Type Description Example batchId String Batch ID. 5bc86b6e85c7209830f96936 Response Example of [...]

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 […]

APIs from iP.1 We at iP.1 think it should be easy to develop and have complete documentation of all our APIs. Choose above which API you want to implement by clicking on the respective box. Discover the possibilities of our APIs By downloading our demo app, you can take a tour of our APIs for [...]