INinfobip
channels
webrtc-calls
call-link
call-links

Create call link

Create a link to send to someone who will then initiate a call.

post/call-link/1/links

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

identitystring

Identity of a user that will use a call link. Must not be set if the destination type of a call link is ROOM.

displayNamestring

Display name of a user that will use a call link to initiate a call. Must not be set if the destination type of a call link is ROOM. For other destination types, if you want to set a display name, also set identity.

showIdentityboolean

Show identity or displayName on before a call.

customDataobject

Custom attributes sent in a call once it has started.

callLinkConfigIdstring

Identifier of a call link configuration. You can use your existing configuration. If this parameter is not sent and there are call link configurations available, the default one will be used. If there are no configurations, the one with system default values will be used.

Example request

{
  "destination": {
    "identity": "bob",
    "type": "WEBRTC"
  },
  "validityWindow": {
    "startTime": "2023-01-01T08:00:00Z",
    "endTime": "2023-12-01T16:00:00Z"
  }
}

Response

Created

idstring

Identifier of the created call link. To open a call link, an ID will be concatenated to the URL: https://call-link.com/.

urlstring

A URL to initiate the call.

Changes

No recorded changes to this operation across all 1 revision of this API.