> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/tools-tips-and-tricks/restful-api/prosbc-restful-api-sip-domain.md).

# ProSBC:Restful API SIP Domain

```
{
    "min_contact_expire": "30 seconds",
    "max_contact_expire": "1 hour",
    "enabled": true,
    "routing_method": "Register Source",
    "domain_name": "sip.telcobridges.com",
    "advanced_parameters": {
        "poll_registered_users_parameters": {
            "***meta***": {
                "valid_url": false
            },
            "poll_registered_users_interval": "20 seconds",
            "poll_registered_users_user_agent": "",
            "poll_registered_users": false
        },
        "unsubscribe_on_unregister": true,
        "***meta***": {
            "valid_url": false
        },
        "contact_expire_grace_time": "1 minute",
        "strict_user_matching": false
    },
    "sip_registration_registrars": {},
    "***meta***": {
        "version": "3.1.137",
        "src_path": ""
    },
    "naps": [
        "3CX",
        "OPEN_NAP"
    ],
    "default_contact_expire": "1 hour",
    "forwarding_parameters": {
        "forwarding_mode": "Contact Remapping",
        "***meta***": {
            "valid_url": false
        },
        "forward_after_switchover": true,
        "override_received_user_agent": false,
        "max_simultaneous_register_forward": 10000,
        "max_pending_register_forward": 10000,
        "min_registrar_expire": "1 hour"
    },
    "name": "TEST_DOMAIN",
    "unique_name": "sip.telcobridges.com",
    "registration_method": "Forwarding",
    "max_registered_users": 100000
}

```

Important parameters in the JSON file

* [name](/configuration-details/configuration-parameters-all.md#parameter-name)
* [domain\_name](/configuration-details/configuration-parameters-all.md#parameter-domain-name)
* [routing\_method](/configuration-details/configuration-parameters-all.md#parameter-routing-method)
* [forwarding\_mode](/configuration-details/configuration-parameters-all.md#parameter-forwarding-mode)

### Add a new SIP Domain

Add a new SIP Domain with the POST command:

POST [http://ProSBCIP:12358/configurations/configuration\_name/sip\_registration\_domains/](http://prosbcip:12358/configurations/configuration_name/sip_registration_domains/)

\
ProSBC creates a new SIP Domain from the name in the JSON file.

Example: Using the Postman tool, the URL is:

<http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/>

<figure><img src="https://docs.telcobridges.com/w/images/thumb/a/ae/RestFul_sip_domain_Post_Send.png/800px-RestFul_sip_domain_Post_Send.png" alt=""><figcaption></figcaption></figure>

\
If the new SIP Domain is created successfully, the following message is returned:

<br>

<figure><img src="https://docs.telcobridges.com/w/images/thumb/b/b8/RestFul_sip_domain_Post_Response.png/800px-RestFul_sip_domain_Post_Response.png" alt=""><figcaption></figcaption></figure>

### Modify a SIP Domain

Modify the existing SIP Domain with the PUT command:

PUT [http://ProSBCIP:12358/configurations/configurationname/sip\_registration\_domains/sip\_domain\_name](http://prosbcip:12358/configurations/configurationname/sip_registration_domains/sip_domain_name)

Example: Using the Postman tool, the URL is

<http://192.168.1.25:12358/configurations/config_2/sip_registration_domains/TEST_DOMAIN> and changed routing\_method to Contact

<figure><img src="https://docs.telcobridges.com/w/images/thumb/f/f1/SIP_Domain_Put_Send.png/800px-SIP_Domain_Put_Send.png" alt=""><figcaption></figcaption></figure>

\
If the update is successful, the following message is returned:

<br>

<figure><img src="https://docs.telcobridges.com/w/images/thumb/6/60/SIP_Domain_Put_Response.png/800px-SIP_Domain_Put_Response.png" alt=""><figcaption></figcaption></figure>

\
Learn more about how to use RestFul API and Postman Tool from the following link [Northbound\_interface:RESTful](/tools-tips-and-tricks/restful-api.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://prosbcdocs.telcobridges.com/tools-tips-and-tricks/restful-api/prosbc-restful-api-sip-domain.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.