CURLOPT()¶

Synopsis¶

Sets various options for future invocations of CURL.

Since¶

10.0.0

Description¶

Options may be set globally or per channel. Per-channel settings will override global settings. Only HTTP headers are added instead of overriding

Syntax¶

CURLOPT(key)

Arguments¶

• key

  • cookie - A cookie to send with the request. Multiple cookies are supported.
    

  • conntimeout - Number of seconds to wait for a connection to succeed
    

  • dnstimeout - Number of seconds to wait for DNS to be resolved
    

  • followlocation - Whether or not to follow HTTP 3xx redirects (boolean)
    

  • ftptext - For FTP URIs, force a text transfer (boolean)
    

  • ftptimeout - For FTP URIs, number of seconds to wait for a server response
    

  • header - Include header information in the result (boolean)
    

  • httpauth - Type of authentication method to use. The default is Basic Authentication.
    Multiple values can be specified to enable multiple authentication methods. To do so, invoke CURLOPT once using comma-separated values.
    

    • basic

    • digest

  • httpheader - Add HTTP header. Multiple calls add multiple headers. Setting of any header will remove the default "Content-Type application/x-www-form-urlencoded"
    

  • httptimeout - For HTTP(S) URIs, number of seconds to wait for a server response
    

  • maxredirs - Maximum number of redirects to follow. The default is -1, which allows for unlimited redirects. This only makes sense when followlocation is also set.
    

  • proxy - Hostname or IP address to use as a proxy server
    

  • proxytype - Type of 'proxy'
    

    • http

    • socks4

    • socks5

  • proxyport - Port number of the 'proxy'
    

  • proxyuserpwd - A username':'password combination to use for authenticating requests through a 'proxy'
    

  • referer - Referer URL to use for the request
    

  • useragent - UserAgent string to use for the request
    

  • userpwd - A username':'password to use for authentication when the server response to an initial request indicates a 401 status code.
    

  • ssl_verifypeer - Whether to verify the server certificate against a list of known root certificate authorities (boolean).
    

  • ssl_verifyhost - Whether to verify the host in the server's TLS certificate. Set to 2 to verify the host, 0 to ignore the host.
    

  • ssl_cainfo - Path to a file holding one or more certificates to verify the peer's certificate with. Only used when 'ssl_verifypeer' is enabled.
    

  • ssl_capath - Path to a directory holding multiple CA certificates to verify the peer's certificate with. Only used when 'ssl_verifypeer' is enabled.
    

  • ssl_cert - Path to a file containing a client certificate. Default format is PEM, and can be changed with 'ssl_certtype'.
    

  • ssl_certtype - The format of the 'ssl_cert' file.
    

    • PEM

    • DER

  • ssl_key - Path to a file containing a client private key. Default format is PEM, and can be changed with 'ssl_keytype'
    

  • ssl_keytype - The format of the 'ssl_key' file.
    

    • PEM

    • DER

    • ENG

  • ssl_keypasswd - The passphrase to use the 'ssl_key' file.
    

  • hashcompat - Assuming the responses will be in 'key1=value1&key2=value2' format, reformat the response such that it can be used by the 'HASH' function.
    

    • yes

    • no

    • legacy - Also translate '+' to the space character, in violation of current RFC standards.
      

  • failurecodes - A comma separated list of HTTP response codes to be treated as errors
    

See Also¶

• Dialplan Functions CURL
• Dialplan Functions HASH

Generated Version¶

This documentation was generated from Asterisk branch 21 using version GIT