Project

General

Profile

API - Schedule Save

API Schedule Save se foloseste pentru a salva programul (orarul) elementelor din centrala.

API URL

https://[YOUR-PBX-URL]/api/schedule

Datele se transmit prin POST sau GET si trebuie sa fie de forma:

Array
(
    [action] => save
    [data] => Array
        (
            [element_type] => project
            [schedule_type] => weekdays
            [schedule_data] => Array
                (
                    [0] => Array
                        (
                            [element_id] => 1
                            [day] => 1
                            [data] => Array
                                (
                                    [0] => Array
                                        (
                                            [start] => 09:00:00
                                            [end] => 18:00:00
                                        )

                                )

                            [break_interval] => 
                            [break_message] => 
                            [welcome_message] => 
                            [ns_welcome_message] => 
                            [closed_message] => 
                            [closed_gosub] => 
                        )

                    [1] => Array
                        (
                            [element_id] => 1
                            [day] => 2
                            [data] => Array
                                (
                                    [0] => Array
                                        (
                                            [start] => 09:00:00
                                            [end] => 17:00:00
                                        )

                                )

                            [break_interval] => 
                            [break_message] => 
                            [welcome_message] => 
                            [ns_welcome_message] => 
                            [closed_message] => 
                            [closed_gosub] => 
                        )

                )

        )

    [api_hash] => 07112231a9c89f5b108af08608a97b07
)

Parametrul action trebuie sa aiba valoarea save.
Parametrul data trebuie sa contina:
- element_type cu una din valoarile: project, inbound_route, contact, user, ivr_menu, pbx_queue
- schedule_type cu valoarea weekdays sau custom

schedule_data este o lista de randuri, cate unul pentru fiecare element si zi:
  • element_id: obligatoriu, ID-ul elementului (trebuie sa existe si sa fie activ)
  • day: obligatoriu pentru weekdays: 0 = duminica, 1 = luni, 2 = marti, 3 = miercuri, 4 = joi, 5 = vineri, 6 = sambata
  • date: obligatoriu pentru custom, format Y-m-d; intervalele noi trebuie sa fie in viitor
  • data: lista intervalelor din zi, fiecare cu start si end (format H:i:s, end mai mare decat start; 00:00:00 - 00:00:00 = inchis toata ziua) si optional key (numarul intervalului in zi) sau delete = 1 (sterge intervalul cu acel key)
  • break_interval (format HH:MM-HH:MM) si break_message: optionale, se trimit impreuna
  • welcome_message, ns_welcome_message, closed_message (fisiere audio) si closed_gosub: optionale

Un interval cu key existent este actualizat, fara key este adaugat. La weekdays, un interval trimis fara id / key care exista deja cu acelasi start si end in acea zi este recunoscut si actualizat, nu dublat.

Randurile cu erori sunt ignorate, cele valide sunt salvate; daca exista erori, raspunsul are has_error = true si un singur mesaj care incepe cu Errors saving schedule:.

Headere HTTP:

Content-Type: application/json
Authorization: Bearer <token>

Exemplu generare parametri:

$params = [
    'action' => 'save',
    'data' => [
        'element_type' => 'project',
        'schedule_type' => 'weekdays',
        'schedule_data' => [
            [
                'element_id' => 1,
                'day' => 1,
                'data' => [
                    [
                        //'id' => 2,
                        //'key' => 1,
                        'start' => '09:00:00',
                        'end' => '18:00:00'
                    ]
                ],
                'break_interval' => '',
                'break_message' => '',
                'welcome_message' => '',
                'ns_welcome_message' => '',
                'closed_message' => '',
                'closed_gosub' => ''
            ],
            [
                'element_id' => 1,
                'day' => 2,
                'data' => [
                    [
                        //'id' => 3,
                        //'key' => 1,
                        'start' => '09:00:00',
                        'end' => '17:00:00'
                    ]
                ],
                'break_interval' => '',
                'break_message' => '',
                'welcome_message' => '',
                'ns_welcome_message' => '',
                'closed_message' => '',
                'closed_gosub' => ''
            ]
        ]
    ]
];

Exemplu generare hash:

$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash

Exemplu trimitere date:

$url = 'https://[YOUR-PBX-URL]/api/schedule';
$token = 'your_api_token';
echo curlPost($url, json_encode($params), array("Authorization: Bearer {$token}", "Content-Type: application/json"));

Date trimise JSON

{
  "action": "save",
  "data": {
    "element_type": "project",
    "schedule_type": "weekdays",
    "schedule_data": [
      {
        "element_id": 1,
        "day": 1,
        "data": [
          {
            "start": "09:00:00",
            "end": "18:00:00" 
          }
        ],
        "break_interval": "",
        "break_message": "",
        "welcome_message": "",
        "ns_welcome_message": "",
        "closed_message": "",
        "closed_gosub": "" 
      },
      {
        "element_id": 1,
        "day": 2,
        "data": [
          {
            "start": "09:00:00",
            "end": "17:00:00" 
          }
        ],
        "break_interval": "",
        "break_message": "",
        "welcome_message": "",
        "ns_welcome_message": "",
        "closed_message": "",
        "closed_gosub": "" 
      }
    ]
  },
  "api_hash": "07112231a9c89f5b108af08608a97b07" 
}

Raspuns

In caz de succes (saved = numarul de intervale adaugate, modificate sau sterse):

{
  "has_error": false,
  "messages": [],
  "results": {
    "saved": 1
  }
}

Sau in caz de eroare:

{

    "has_error": true,
    "messages": [
        "Errors saving schedule: Invalid schedule Element ID for Monday; Invalid Start time for Tuesday (#1)" 
    ],
    "results": [ ]

}

Disponibil si in alte limbi: EN