Get bridge route - Polymorfa

GET

/

messaging

/

bridge

/

route

Get bridge route

curl --request GET \
  --url https://api.polymorfa.com/messaging/bridge/route \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/messaging/bridge/route', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.polymorfa.com/messaging/bridge/route"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "wsUrl": "<string>",
  "region": "BR",
  "kind": "sandbox",
  "signal": "customer",
  "tokenKind": "project",
  "expiresAt": 1
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
}

Authorizations

Authorization

string

header

required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Response

OK

wsUrl

string<uri>

required

URL for the ws.

Value constraints

Constraint	Accepted input
Format	`uri`

region

enum<string>

required

Specifies region for this schema.

Allowed values

Value	Meaning
`BR`	Br.
`US`	Us.
`IN`	In.
`Auto`	Auto.

Available options:

BR,

US,

IN,

Auto

kind

enum<string>

required

Kind discriminator for this object.

Allowed values

Value	Meaning
`sandbox`	Sandbox.
`production`	Production.

Available options:

sandbox,

production

signal

enum<string>

required

Specifies signal for this schema.

Allowed values

Value	Meaning
`customer`	Customer.
`bartender`	Bartender.

Available options:

customer,

bartender

tokenKind

enum<string>

required

Category assigned to token.

Allowed values

Value	Meaning
`project`	Project.

Available options:

project

expiresAt

integer

required

Unix timestamp in milliseconds when this resource expires.

Value constraints

Constraint	Accepted input
Numeric value	`0` or greater

Required range: x >= 0

⌘I

Get bridge route

curl --request GET \
  --url https://api.polymorfa.com/messaging/bridge/route \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/messaging/bridge/route', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.polymorfa.com/messaging/bridge/route"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "wsUrl": "<string>",
  "region": "BR",
  "kind": "sandbox",
  "signal": "customer",
  "tokenKind": "project",
  "expiresAt": 1
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
}