/msml

Resource URI

/msml

HTTP GET

Sets and retrieves all MSML server settings.

GET /msml

Method

Response Payload

JSON

{
  "version": "1.1",
  "http_caching": "no",
  "schema_validation": "no",
  "adaptor_port": "32868",
  "storage_directory": "/var/lib/xms/media/en_US",
  "content_type": "xml",
  "encoding": "utf_8",
  "clear_db": "yes",
  "dtmf_start_time": "no",
  "adv_digit_pattern": "no",
  "video_fast_update": "INFO",
  "video_bandwidth": "512",
  "conf_agc_default": "no",
  "default_amr_alignment": "BANDWIDTH_EFFICIENT",
  "dtmf_detect_mode": "RFC2833",
  "dns_cache_timeout": "60",
  "cert_verify_peer": "no",
  "cert_verify_host": "no",
  "cpa": [
    {
      "config1": {
        "cnosig": 40000,
        "no_answer": 30000,
        "pamd_failtime": 4000
      }
    }
  ]
}

HTTP PUT

Modifies the MSML server configuration.

PUT /msml

Valid "version" settings:

Valid "content_type" settings:

Valid "encoding" settings:

Valid "video_fast_update" settings:

Valid "http_caching", "schema_validation", "clear_db", "dtmf_start_time", "adv_digit_pattern", "cert_verify_peer", and "cert_verify_host" settings:

Valid "bandwidth_modifier" settings (in kbps):

Valid "dtmf_detect_mode" settings:

Valid "default_amr_alignment" settings:

Valid "dns_cache_timeout" settings (in seconds):

CPA (cpa) configuration defines how CPA operates. For instance, the time required before "no answer" is declared. In a MSML script, the "cfgname" attribute is set on the <cpa> element to specify the "config1" configuration as follows.

<cpa cfgname="config1"/>

Continuous No Signal (cnosig) is the maximum time of silence, with no signal, allowed immediately after cadence detection begins. If exceeded, a "no ringback" MSML event is generated by the media server.

No Answer (no_answer) is the length of time to wait after first ringback before deciding that the call is not answered.

PAMD Fail Time (pamd_failtime) is the maximum time to wait for positive answering machine detection or positive voice detection after a cadence break.

Method Request Payload Response Payload
JSON

{
  "http_caching" : "yes",
  "cpa": [
    {
      "config2": {
        "cnosig": 40000,
        "no_answer": 30000,
        "pamd_failtime": 4000
      }
    }
  ]
}

{
  "version": "1.1",
  "http_caching": "yes",
  "schema_validation": "no",
  "adaptor_port": "32868",
  "storage_directory": "/var/lib/xms/media/en_US",
  "content_type": "xml",
  "encoding": "utf_8",
  "clear_db": "yes",
  "dtmf_start_time": "no",
  "adv_digit_pattern": "no",
  "video_fast_update": "INFO",
  "video_bandwidth": "512",
  "conf_agc_default": "no",
  "default_amr_alignment": "BANDWIDTH_EFFICIENT",
  "dtmf_detect_mode": "RFC2833",
  "dns_cache_timeout": "60",
  "cert_verify_peer": "no",
  "cert_verify_host": "no",
  "cpa": [
    {
      "config2": {
        "cnosig": 40000,
        "no_answer": 30000,
        "pamd_failtime": 4000
      }
    }
  ]
}