Batch - Send campaign

POST

api

batch

send

curl --request POST \
  --url https://getsimio.app/api/batch/send \
  --header 'Content-Type: application/json' \
  --header 'simio-api-key: <api-key>' \
  --data '
{
  "campaign_id": 123,
  "contacts": [
    {
      "phone": "+33612345678"
    }
  ]
}
'

import requests

url = "https://getsimio.app/api/batch/send"

payload = {
    "campaign_id": 123,
    "contacts": [{ "phone": "+33612345678" }]
}
headers = {
    "simio-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'simio-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({campaign_id: 123, contacts: [{phone: '+33612345678'}]})
};

fetch('https://getsimio.app/api/batch/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://getsimio.app/api/batch/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => 123,
    'contacts' => [
        [
                'phone' => '+33612345678'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "simio-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://getsimio.app/api/batch/send"

	payload := strings.NewReader("{\n  \"campaign_id\": 123,\n  \"contacts\": [\n    {\n      \"phone\": \"+33612345678\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("simio-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://getsimio.app/api/batch/send")
  .header("simio-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": 123,\n  \"contacts\": [\n    {\n      \"phone\": \"+33612345678\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://getsimio.app/api/batch/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["simio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": 123,\n  \"contacts\": [\n    {\n      \"phone\": \"+33612345678\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Campaign send enqueued",
  "status": "accepted"
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Invalid API key"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

{
  "error": "Rate limit exceeded: 10 per 1 second"
}

Authorizations

simio-api-key

string

header

required

Company API key, created in Settings > Integrations & developers > Credentials.

Body

application/json

campaign_id

integer

required

ID of the Simio campaign to send.

Required range: x >= 1

Example:

123

contacts

BatchContact · object[]

required

Recipients of the campaign (1 to 1000 per request).

Required array length: 1 - 1000 elements

Show child attributes

Example:

[{ "phone": "+33612345678" }]

Response

Successful Response

message

string

required

Human-readable confirmation.

Example:

"Campaign send enqueued"

status

string

required

Always accepted: the send is queued and processed in the background.

Allowed value: "accepted"

Example:

"accepted"

⌘I

Batch - Send campaign

curl --request POST \
  --url https://getsimio.app/api/batch/send \
  --header 'Content-Type: application/json' \
  --header 'simio-api-key: <api-key>' \
  --data '
{
  "campaign_id": 123,
  "contacts": [
    {
      "phone": "+33612345678"
    }
  ]
}
'

import requests

url = "https://getsimio.app/api/batch/send"

payload = {
    "campaign_id": 123,
    "contacts": [{ "phone": "+33612345678" }]
}
headers = {
    "simio-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'simio-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({campaign_id: 123, contacts: [{phone: '+33612345678'}]})
};

fetch('https://getsimio.app/api/batch/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://getsimio.app/api/batch/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'campaign_id' => 123,
    'contacts' => [
        [
                'phone' => '+33612345678'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "simio-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://getsimio.app/api/batch/send"

	payload := strings.NewReader("{\n  \"campaign_id\": 123,\n  \"contacts\": [\n    {\n      \"phone\": \"+33612345678\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("simio-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://getsimio.app/api/batch/send")
  .header("simio-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaign_id\": 123,\n  \"contacts\": [\n    {\n      \"phone\": \"+33612345678\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://getsimio.app/api/batch/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["simio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"campaign_id\": 123,\n  \"contacts\": [\n    {\n      \"phone\": \"+33612345678\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Campaign send enqueued",
  "status": "accepted"
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Invalid API key"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

{
  "error": "Rate limit exceeded: 10 per 1 second"
}

Connectors

API External

Batch - Send campaign

Authorizations

Body

Response