SIP Registration API

create new entry

POST /api/rest/admin/registrations

Parameters

Name	Description
data[type]	Resource type (registrations)
data[attributes][domain]	Domain
data[attributes][name]	Name
data[attributes][contact]	Contact
data[attributes][username]	Username
data[attributes][sip-schema-id]	Sip schema id
data[attributes][auth-password]	Auth password
data[attributes][auth-user]	Auth user
data[attributes][contact]	Contact
data[attributes][display-username]	Display username
data[attributes][domain]	Domain
data[attributes][enabled]	Enabled
data[attributes][expire]	Expire
data[attributes][force-expire]	Force expire
data[attributes][max-attempts]	Max attempts
data[attributes][route-set]	Route set
data[attributes][retry-delay]	Retry delay
data[attributes][sip-interface-name]	Sip interface name
data[relationships][transport-protocol]	Transport protocol
data[relationships][node]	Node
data[relationships][pop]	Pop

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE4OSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAwOX0.-SP2vHg4BjeM8Iq9uYDPRBa248jL5CWgj4QJJDreoVE
Host: example.org
Cookie: 

Route

POST /api/rest/admin/registrations

Body

{"data":{"type":"registrations","attributes":{"domain":"ruri-domain","name":"name","contact":"sip:contact@domain;param","username":"ruri-username","sip-schema-id":1},"relationships":{"transport-protocol":{"data":{"type":"transport-protocols","id":1}}}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/admin/registrations/8
vary: Accept
etag: W/"5ffb30844559505756aa7bc343c0dcf4"
cache-control: max-age=0, private, must-revalidate
x-request-id: 3b3e5cba-ad5b-4c45-aad5-54405b36e41c
x-runtime: 0.012653
content-length: 983

Status

201 Created

Body

{
  "data": {
    "id": "8",
    "type": "registrations",
    "links": {
      "self": "http://example.org/api/rest/admin/registrations/8"
    },
    "attributes": {
      "auth-password": null,
      "auth-user": null,
      "contact": "sip:contact@domain;param",
      "display-username": null,
      "domain": "ruri-domain",
      "enabled": true,
      "expire": null,
      "force-expire": false,
      "max-attempts": null,
      "name": "name",
      "route-set": [

      ],
      "retry-delay": 5,
      "sip-interface-name": null,
      "username": "ruri-username",
      "sip-schema-id": 1
    },
    "relationships": {
      "transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/registrations/8/relationships/transport-protocol",
          "related": "http://example.org/api/rest/admin/registrations/8/transport-protocol"
        }
      },
      "pop": {
        "links": {
          "self": "http://example.org/api/rest/admin/registrations/8/relationships/pop",
          "related": "http://example.org/api/rest/admin/registrations/8/pop"
        }
      },
      "node": {
        "links": {
          "self": "http://example.org/api/rest/admin/registrations/8/relationships/node",
          "related": "http://example.org/api/rest/admin/registrations/8/node"
        }
      }
    }
  }
}