API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Jul 21st, 2017
101
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 88.80 KB | None | 0 0
raw download clone embed print report
  1. swagger: '2.0'
  2. info:
  3. version: "0.5"
  4. title: Opentact Api
  5. description: Opentact Api Calls
  6. schemes:
  7. - http
  8. host: 149.56.96.236:8002
  9. basePath: /
  10.  
  11. consumes:
  12. - application/json
  13. produces:
  14. - application/json
  15.  
  16. paths:
  17. /init:
  18. get:
  19. description:
  20. The first stage of Api session initialization sequence (of total 2 steps)
  21. responses:
  22. 200:
  23. description: Success
  24.  
  25.  
  26. parameters:
  27. - name : Authorization
  28. in : header
  29. type : string
  30. default : init
  31. required : true
  32.  
  33. tags:
  34. - init
  35.  
  36. /init/{init_token}:
  37. post:
  38. description:
  39. The second stage of Api session initialization sequence (of total 2 steps)
  40. responses:
  41. 200:
  42. description: Success
  43.  
  44. parameters:
  45. - name : Authorization
  46. in : header
  47. type : string
  48. default : init
  49. required : true
  50.  
  51. - name: init_token
  52. in : path
  53. type : string
  54. required : true
  55. description : The value that is read from 1st step of initialization
  56.  
  57. - name: identity_token
  58. in : formData
  59. type : string
  60. required : true
  61. description : The value that is calculated by relevant function, given in examples
  62.  
  63. - name: user_id
  64. in : formData
  65. type : string
  66. required : false
  67. description : Optional variable provided by developer, for identifying user in his/her system
  68.  
  69. tags:
  70. - init
  71.  
  72. /int/check_token:
  73. post:
  74. description:
  75. Used to check/verify the init token that is given in header
  76. responses:
  77. 200:
  78. description: Success
  79.  
  80. parameters:
  81. - name : Authorization
  82. in : header
  83. type : string
  84. required : true
  85.  
  86. tags:
  87. - token
  88.  
  89. /int/verify_token:
  90. post:
  91. description:
  92. Used to check/verify the init token that is given in header (same as check_token)
  93. responses:
  94. 200:
  95. description: Success
  96.  
  97. parameters:
  98. - name : Authorization
  99. in : header
  100. type : string
  101. required : true
  102.  
  103. tags:
  104. - token
  105.  
  106.  
  107.  
  108. /1/register_sip/0:
  109. post:
  110. description:
  111. register_sip
  112. responses:
  113. 200:
  114. description: Success
  115.  
  116. parameters:
  117. - name : Authorization
  118. in : header
  119. type : string
  120. required : true
  121. description: The session token that is got from init sequence
  122.  
  123. tags:
  124. - sip
  125.  
  126.  
  127. /1/invite_sip/0:
  128. post:
  129. description:
  130. register_sip
  131. responses:
  132. 200:
  133. description: Success
  134.  
  135. parameters:
  136. - name : Authorization
  137. in : header
  138. type : string
  139. required : true
  140. description: The session token that is got from init sequence
  141.  
  142. tags:
  143. - sip
  144.  
  145.  
  146. /1/xmpp/register:
  147. post:
  148. description:
  149. register_sip
  150. responses:
  151. 200:
  152. description: Success
  153.  
  154. parameters:
  155. - name : Authorization
  156. in : header
  157. type : string
  158. required : true
  159. description: The session token that is got from init sequence
  160.  
  161. tags:
  162. - xmpp
  163.  
  164.  
  165. /1/xmpp/user_exists:
  166. post:
  167. description:
  168. user_exists
  169. responses:
  170. 200:
  171. description: Success
  172.  
  173. parameters:
  174. - name : Authorization
  175. in : header
  176. type : string
  177. required : true
  178. description: The session token that is got from init sequence
  179.  
  180. tags:
  181. - xmpp
  182.  
  183. /1/xmpp/check_password?user={user}&pass={pass}:
  184. get:
  185. description:
  186. user_exists
  187. responses:
  188. 200:
  189. description: Success
  190.  
  191. parameters:
  192. - name : Authorization
  193. in : header
  194. type : string
  195. required : true
  196. description: The session token that is got from init sequence
  197.  
  198. - name: user
  199. in: path
  200. type: string
  201. required: true
  202. description: The user to check password
  203.  
  204. - name: pass
  205. in: path
  206. type: string
  207. required: true
  208. description: The pass to check validity
  209.  
  210. tags:
  211. - xmpp
  212.  
  213. /1/xmpp/get_password?user={user_id}:
  214. post:
  215. description:
  216. get password
  217. responses:
  218. 200:
  219. description: Success
  220.  
  221. parameters:
  222. - name : Authorization
  223. in : header
  224. type : string
  225. required : true
  226. description: The session token that is got from init sequence
  227.  
  228. - name : user_id
  229. in : path
  230. type : string
  231. required : true
  232. description: User Id to perfom action
  233.  
  234. tags:
  235. - xmpp
  236.  
  237. /1/xmpp/set_password:
  238. post:
  239. description:
  240. set password
  241. responses:
  242. 200:
  243. description: Success
  244.  
  245. parameters:
  246. - name : Authorization
  247. in : header
  248. type : string
  249. required : true
  250. description: The session token that is got from init sequence
  251.  
  252. - name : user
  253. in : formData
  254. type : string
  255. required : true
  256.  
  257. - name : pass
  258. in : formData
  259. type : string
  260. required : true
  261.  
  262. tags:
  263. - xmpp
  264.  
  265. /1/xmpp/remove_user?user={user_id}:
  266. post:
  267. description:
  268. remove user
  269. responses:
  270. 200:
  271. description: Success
  272.  
  273. parameters:
  274. - name : Authorization
  275. in : header
  276. type : string
  277. required : true
  278. description: The session token that is got from init sequence
  279.  
  280. - name : user_id
  281. in : path
  282. type : string
  283. required : true
  284. description: User Id to perfom action
  285.  
  286. tags:
  287. - xmpp
  288.  
  289. /1/xmpp/remove_user_validate?user={user_id}:
  290. post:
  291. description:
  292. remove user validate
  293. responses:
  294. 200:
  295. description: Success
  296.  
  297. parameters:
  298. - name : Authorization
  299. in : header
  300. type : string
  301. required : true
  302. description: The session token that is got from init sequence
  303.  
  304. - name : pass
  305. in : formData
  306. type : string
  307. required : true
  308.  
  309. - name : user_id
  310. in : path
  311. type : string
  312. required : true
  313. description: User Id to perfom action
  314.  
  315. tags:
  316. - xmpp
  317.  
  318. /app/{app_uuid}/identity:
  319. post:
  320. description:
  321. Add Identity
  322. responses:
  323. 200:
  324. description: Success
  325.  
  326. parameters:
  327. - name : Authorization
  328. in : header
  329. type : string
  330. required : true
  331. description: The session token that is got from init sequence
  332.  
  333. - name: app_uuid
  334. in: path
  335. type: string
  336. required: true
  337. description: The App uuid
  338.  
  339. - name: user_name
  340. in: formData
  341. type: string
  342. required: false
  343. description: user_name for Identity, if any
  344.  
  345. - name: name
  346. in: formData
  347. type: string
  348. required: false
  349. description: Name of Identity, if any
  350.  
  351. - name: avatar
  352. in: formData
  353. type: string
  354. required: false
  355. description: avatar of Identity, if any
  356.  
  357. - name: url
  358. in: formData
  359. type: string
  360. required: false
  361. description: url of Identity, if any
  362.  
  363. - name: status
  364. in: formData
  365. type: string
  366. required: false
  367.  
  368. tags:
  369. - app
  370.  
  371. patch:
  372. description:
  373. Modify Identity
  374. responses:
  375. 200:
  376. description: Success
  377.  
  378. parameters:
  379. - name : Authorization
  380. in : header
  381. type : string
  382. required : true
  383. description: The session token that is got from init sequence
  384.  
  385. - name: user_name
  386. in: formData
  387. type: string
  388. required: false
  389. description: user_name for Identity, if any
  390.  
  391. - name: name
  392. in: formData
  393. type: string
  394. required: false
  395. description: Name of Identity, if any
  396.  
  397. - name: avatar
  398. in: formData
  399. type: string
  400. required: false
  401. description: avatar of Identity, if any
  402.  
  403. - name: url
  404. in: formData
  405. type: string
  406. required: false
  407. description: url of Identity, if any
  408.  
  409. - name: status
  410. in: formData
  411. type: string
  412. required: false
  413.  
  414. tags:
  415. - app
  416.  
  417. /app/{app_uuid}/identities:
  418. get:
  419. description:
  420. Get list of identities
  421. responses:
  422. 200:
  423. description: Success
  424.  
  425. parameters:
  426. - name : Authorization
  427. in : header
  428. type : string
  429. required : true
  430. description: The session token that is got from init sequence
  431.  
  432. - name: app_uuid
  433. in: path
  434. type: string
  435. required: true
  436. description: The App uuid
  437.  
  438. tags:
  439. - app
  440.  
  441. /identity/{identity_uuid}/identity_session_token:
  442. post:
  443. description:
  444. Add/create session token for Identity
  445. responses:
  446. 200:
  447. description: Success
  448.  
  449. parameters:
  450. - name : Authorization
  451. in : header
  452. type : string
  453. required : true
  454. description: The session token that is got from init sequence
  455.  
  456. - name: identity_uuid
  457. in: path
  458. type: string
  459. required: true
  460. description: The Identity uuid
  461.  
  462. tags:
  463. - identity
  464.  
  465. /identity/{identity_uuid}/identity_session_tokens:
  466. get:
  467. description:
  468. Get session tokens for Identity
  469. responses:
  470. 200:
  471. description: Success
  472.  
  473. parameters:
  474. - name : Authorization
  475. in : header
  476. type : string
  477. required : true
  478. description: The session token that is got from init sequence
  479.  
  480. - name: identity_uuid
  481. in: path
  482. type: string
  483. required: true
  484. description: The Identity uuid
  485.  
  486.  
  487. tags:
  488. - identity
  489.  
  490. /identity/{identity_uuid}:
  491. get:
  492. description:
  493. Get Identity info
  494. responses:
  495. 200:
  496. description: Success
  497.  
  498. parameters:
  499. - name : Authorization
  500. in : header
  501. type : string
  502. required : true
  503. description: The session token that is got from init sequence
  504.  
  505. - name: identity_uuid
  506. in: path
  507. type: string
  508. required: true
  509.  
  510. tags:
  511. - identity
  512.  
  513. delete:
  514. description:
  515. Delete identity
  516. responses:
  517. 200:
  518. description: Success
  519.  
  520. parameters:
  521. - name : Authorization
  522. in : header
  523. type : string
  524. required : true
  525. description: The session token that is got from init sequence
  526.  
  527. - name: identity_uuid
  528. in: path
  529. type: string
  530. required: true
  531. description: Identity uuid
  532.  
  533. tags:
  534. - identity
  535.  
  536. /identity/{identity_uuid}/suspend:
  537. patch:
  538. description:
  539. suspend identity
  540. responses:
  541. 200:
  542. description: Success
  543.  
  544. parameters:
  545. - name : Authorization
  546. in : header
  547. type : string
  548. required : true
  549. description: The session token that is got from init sequence
  550.  
  551. - name: identity_uuid
  552. in: path
  553. type: string
  554. required: true
  555. description: Identity uuid
  556.  
  557. tags:
  558. - identity
  559.  
  560. /identity/{identity_uuid}/unsuspend:
  561. patch:
  562. description:
  563. UnSuspend identity
  564. responses:
  565. 200:
  566. description: Success
  567.  
  568. parameters:
  569. - name : Authorization
  570. in : header
  571. type : string
  572. required : true
  573. description: The session token that is got from init sequence
  574.  
  575. - name: identity_uuid
  576. in: path
  577. type: string
  578. required: true
  579. description: Identity uuid
  580.  
  581.  
  582. tags:
  583. - identity
  584.  
  585. /identity/{identity_uuid}/status:
  586. post:
  587. description:
  588. Set Identity status
  589. responses:
  590. 200:
  591. description: Success
  592.  
  593. parameters:
  594. - name : Authorization
  595. in : header
  596. type : string
  597. required : true
  598. description: The session token that is got from init sequence
  599.  
  600. - name : status
  601. in : formData
  602. type : string
  603. required : true
  604. description: online/offline/away/do not disturb etc
  605.  
  606.  
  607. - name : identity_uuid
  608. in : path
  609. type : string
  610. required : true
  611. description: Identity uuid to perfom action
  612.  
  613. tags:
  614. - identity
  615.  
  616. /app/{app_uuid}/search/{user_name}/{name}/:
  617. get:
  618. description:
  619. Search for identities by name or user_name
  620.  
  621. responses:
  622. 200:
  623. description: Success
  624.  
  625. parameters:
  626.  
  627. - name : Authorization
  628. in : header
  629. type : string
  630. required : true
  631. description: The session token that is got from init sequence
  632.  
  633.  
  634. - name : app_uuid
  635. in : path
  636. type : string
  637. required : true
  638. description: The App uuid
  639.  
  640. - name : user_name
  641. in : path
  642. type : string
  643. required : false
  644.  
  645. - name : name
  646. in : path
  647. type : string
  648. required : false
  649.  
  650. tags:
  651. - identity
  652.  
  653. /app/{app_uuid}/search:
  654. post:
  655. description:
  656. Search for identities by name or user_name
  657.  
  658. responses:
  659. 200:
  660. description: Success
  661.  
  662. parameters:
  663.  
  664. - name : Authorization
  665. in : header
  666. type : string
  667. required : true
  668. description: The session token that is got from init sequence
  669.  
  670.  
  671. - name : app_uuid
  672. in : path
  673. type : string
  674. required : true
  675. description: The App uuid
  676.  
  677. - name : user_name
  678. in : formData
  679. type : string
  680. required : false
  681.  
  682. - name : name
  683. in : formData
  684. type : string
  685. required : false
  686.  
  687. tags:
  688. - identity
  689.  
  690.  
  691.  
  692. /int/app:
  693. post:
  694. description:
  695. Add an application
  696. responses:
  697. 200:
  698. description: Success
  699.  
  700.  
  701. parameters:
  702. - name : Authorization
  703. in : header
  704. type : string
  705. required : true
  706. description: The session token that is got from init sequence
  707.  
  708. - name: name
  709. in: formData
  710. type: string
  711. required: false
  712. description: The App name
  713.  
  714. - name: description
  715. in: formData
  716. type: string
  717. required: false
  718. description: Description of application
  719.  
  720. - name: dev_uuid
  721. in: formData
  722. type: string
  723. required: true
  724.  
  725. - name: dev_token
  726. in: formData
  727. type: string
  728. required: true
  729.  
  730. - name: tech_prefix
  731. in: formData
  732. type: string
  733. required: true
  734.  
  735. - name: allowed_countries
  736. in: formData
  737. type: string
  738. required: false
  739. description: Comma separated list of allowed country codes
  740.  
  741. - name: status
  742. in: formData
  743. type: string
  744. required: false
  745.  
  746. tags:
  747. - app
  748.  
  749. patch:
  750. description:
  751. App Edit
  752. responses:
  753. 200:
  754. description: Success
  755.  
  756. parameters:
  757. - name : app_uuid
  758. in : formData
  759. type : string
  760. required : true
  761.  
  762. - name : description
  763. in : formData
  764. type : string
  765. required : false
  766.  
  767. - name : tech_prefix
  768. in : formData
  769. type : string
  770. required : false
  771.  
  772. - name : name
  773. in : formData
  774. type : string
  775. required : false
  776.  
  777. - name : XiaomiAPPSecret
  778. in : formData
  779. type : string
  780. required : false
  781.  
  782. - name : HuaweiAPSecret
  783. in : formData
  784. type : string
  785. required : false
  786.  
  787. - name : HuaweiAPPSecret
  788. in : formData
  789. type : string
  790. required : false
  791.  
  792. - name : APNKey
  793. in : formData
  794. type : string
  795. required : false
  796.  
  797. tags:
  798. - app
  799.  
  800.  
  801. delete:
  802. description:
  803. App Delete
  804. responses:
  805. 200:
  806. description: Success
  807.  
  808. parameters:
  809. - name : app_uuid
  810. in : formData
  811. type : string
  812. required : true
  813.  
  814. tags:
  815. - app
  816.  
  817. /int/app/{app_uuid}/suspend:
  818. patch:
  819. description:
  820. Suspend an application
  821. responses:
  822. 200:
  823. description: Success
  824.  
  825. parameters:
  826. - name : Authorization
  827. in : header
  828. type : string
  829. required : true
  830. description: The session token that is got from init sequence
  831.  
  832. - name: app_uuid
  833. in: path
  834. type: string
  835. required: true
  836. description: The App id
  837.  
  838. tags:
  839. - app
  840.  
  841. /int/app/{app_uuid}/unsuspend:
  842. patch:
  843. description:
  844. unSuspend an application
  845. responses:
  846. 200:
  847. description: Success
  848.  
  849. parameters:
  850. - name : Authorization
  851. in : header
  852. type : string
  853. required : true
  854. description: The session token that is got from init sequence
  855.  
  856. - name: app_uuid
  857. in: path
  858. type: string
  859. required: true
  860. description: The App id
  861.  
  862.  
  863. tags:
  864. - app
  865.  
  866. /app/{app_uuid}:
  867. get:
  868. description:
  869. Get info (name, description, etc.) about an application
  870. responses:
  871. 200:
  872. description: Success
  873.  
  874. parameters:
  875. - name : Authorization
  876. in : header
  877. type : string
  878. required : true
  879. description: The session token that is got from init sequence
  880.  
  881. - name: app_uuid
  882. in: path
  883. type: string
  884. required: true
  885. description: The App id
  886.  
  887. tags:
  888. - app
  889.  
  890. /int/{dev_uuid}/apps:
  891. get:
  892. description:
  893. Get App List
  894. responses:
  895. 200:
  896. description: Success
  897.  
  898. parameters:
  899. - name : dev_uuid
  900. in : path
  901. type : string
  902. required : true
  903. description: Developer UUID
  904.  
  905.  
  906. tags:
  907. - app
  908.  
  909. /app_perm/{app_uuid}/{token}/{permission}:
  910. get:
  911. description:
  912. Get permission of a token
  913. responses:
  914. 200:
  915. description: Success
  916.  
  917. parameters:
  918. - name : Authorization
  919. in : header
  920. type : string
  921. required : true
  922. description: The session token that is got from init sequence
  923.  
  924. - name: app_uuid
  925. in: path
  926. type: string
  927. required: true
  928. description: The App id
  929.  
  930. - name: token
  931. in: path
  932. type: string
  933. required: true
  934. description: The token to check permission
  935.  
  936. - name: permission
  937. in: path
  938. type: string
  939. required: true
  940. description: The permission to check for
  941.  
  942. tags:
  943. - app
  944.  
  945. /app_perm/{app_uuid}/{token}:
  946. patch:
  947. description:
  948. Set permission of a token
  949. responses:
  950. 200:
  951. description: Success
  952.  
  953. parameters:
  954. - name : Authorization
  955. in : header
  956. type : string
  957. required : true
  958. description: The session token that is got from init sequence
  959.  
  960. - name: app_uuid
  961. in: path
  962. type: string
  963. required: true
  964. description: The App id
  965.  
  966. - name: token
  967. in: path
  968. type: string
  969. required: true
  970. description: The name of token to set permission
  971.  
  972. - name: permission
  973. in: formData
  974. type: string
  975. required: true
  976. description: The permission to set for
  977.  
  978. tags:
  979. - app
  980.  
  981. /app/{app_uuid}/token:
  982. post:
  983. description:
  984. Add a token to app
  985. responses:
  986. 200:
  987. description: Success
  988.  
  989. parameters:
  990. - name : Authorization
  991. in : header
  992. type : string
  993. required : true
  994. description: The session token that is got from init sequence
  995.  
  996. - name: app_uuid
  997. in: path
  998. type: string
  999. required: true
  1000. description: The App id
  1001.  
  1002. - name: token
  1003. in: formData
  1004. type: string
  1005. required: true
  1006. description: The name of token
  1007.  
  1008. tags:
  1009. - app
  1010.  
  1011. /app/{app_uuid}/token/{token}:
  1012. delete:
  1013. description:
  1014. Delete a token from app
  1015. responses:
  1016. 200:
  1017. description: Success
  1018.  
  1019. parameters:
  1020. - name : Authorization
  1021. in : header
  1022. type : string
  1023. required : true
  1024. description: The session token that is got from init sequence
  1025.  
  1026. - name: app_uuid
  1027. in: path
  1028. type: string
  1029. required: true
  1030. description: The App id
  1031.  
  1032. - name: token
  1033. in: path
  1034. type: string
  1035. required: true
  1036. description: The name of token
  1037.  
  1038. tags:
  1039. - app
  1040.  
  1041. /app/{app_uuid}/tokens:
  1042. get:
  1043. description:
  1044. List tokens of an app
  1045. responses:
  1046. 200:
  1047. description: Success
  1048.  
  1049. parameters:
  1050. - name : Authorization
  1051. in : header
  1052. type : string
  1053. required : true
  1054. description: The session token that is got from init sequence
  1055.  
  1056. - name: app_uuid
  1057. in: path
  1058. type: string
  1059. required: true
  1060. description: The App id
  1061.  
  1062.  
  1063. tags:
  1064. - app
  1065.  
  1066. /app/{app_uuid}/im_channel:
  1067. post:
  1068. description:
  1069. Create IM Channel
  1070. responses:
  1071. 200:
  1072. description: Success
  1073.  
  1074. parameters:
  1075. - name : Authorization
  1076. in : header
  1077. type : string
  1078. required : true
  1079. description: The session token that is got from init sequence
  1080.  
  1081.  
  1082. - name : app_uuid
  1083. in : path
  1084. type : string
  1085. required : true
  1086. description: The App uuid
  1087.  
  1088.  
  1089. tags:
  1090. - app
  1091.  
  1092. /im/{app_uuid}/channels:
  1093. get:
  1094. description:
  1095. get all channels
  1096. responses:
  1097. 200:
  1098. description: Success
  1099.  
  1100. parameters:
  1101. - name : Authorization
  1102. in : header
  1103. type : string
  1104. required : true
  1105. description: The session token that is got from init sequence
  1106.  
  1107.  
  1108. - name : app_uuid
  1109. in : path
  1110. type : string
  1111. required : true
  1112. description: The App uuid
  1113.  
  1114.  
  1115. tags:
  1116. - im
  1117.  
  1118. /im/{im_channel_uuid}/channel_info:
  1119. get:
  1120. description:
  1121. Get channel info
  1122. responses:
  1123. 200:
  1124. description: Success
  1125.  
  1126. parameters:
  1127. - name : Authorization
  1128. in : header
  1129. type : string
  1130. required : true
  1131. description: The session token that is got from init sequence
  1132.  
  1133.  
  1134. - name : im_channel_uuid
  1135. in : path
  1136. type : string
  1137. required : true
  1138.  
  1139. tags:
  1140. - im
  1141.  
  1142. /app/im_channel/{im_channel_uuid}:
  1143. delete:
  1144. description:
  1145. Delete IM channel
  1146. responses:
  1147. 200:
  1148. description: Success
  1149.  
  1150. parameters:
  1151. - name : Authorization
  1152. in : header
  1153. type : string
  1154. required : true
  1155. description: The session token that is got from init sequence
  1156.  
  1157.  
  1158. - name : im_channel_uuid
  1159. in : path
  1160. type : string
  1161. required : true
  1162.  
  1163. tags:
  1164. - app
  1165.  
  1166.  
  1167. /im/{im_channel_uuid}:
  1168. patch:
  1169. description:
  1170. Update IM Channel
  1171. responses:
  1172. 200:
  1173. description: Success
  1174.  
  1175. parameters:
  1176. - name : Authorization
  1177. in : header
  1178. type : string
  1179. required : true
  1180. description: The session token that is got from init sequence
  1181.  
  1182.  
  1183. - name : im_channel_uuid
  1184. in : path
  1185. type : string
  1186. required : true
  1187.  
  1188.  
  1189.  
  1190. tags:
  1191. - im
  1192.  
  1193. /im/{app_uuid}/announcements:
  1194. get:
  1195. description:
  1196. Get all announcements
  1197. responses:
  1198. 200:
  1199. description: Success
  1200.  
  1201. parameters:
  1202. - name : Authorization
  1203. in : header
  1204. type : string
  1205. required : true
  1206. description: The session token that is got from init sequence
  1207.  
  1208. - name : app_uuid
  1209. in : path
  1210. type : string
  1211. required : true
  1212. description: The App uuid
  1213.  
  1214. tags:
  1215. - im
  1216.  
  1217. /im/{app_uuid}/announcement/{announcement_uuid}:
  1218. get:
  1219. description:
  1220. Get Announcement Info
  1221. responses:
  1222. 200:
  1223. description: Success
  1224.  
  1225. parameters:
  1226. - name : Authorization
  1227. in : header
  1228. type : string
  1229. required : true
  1230. description: The session token that is got from init sequence
  1231.  
  1232. - name : app_uuid
  1233. in : path
  1234. type : string
  1235. required : true
  1236. description: The App uuid
  1237.  
  1238. - name : announcement_uuid
  1239. in : path
  1240. type : string
  1241. required : true
  1242. description: The Announcement uuid
  1243.  
  1244. tags:
  1245. - im
  1246.  
  1247. /im/{app_uuid}/announcement:
  1248. post:
  1249. description:
  1250. Send Announcement
  1251. responses:
  1252. 200:
  1253. description: Success
  1254.  
  1255. parameters:
  1256. - name : Authorization
  1257. in : header
  1258. type : string
  1259. required : true
  1260. description: The session token that is got from init sequence
  1261.  
  1262. - name : body
  1263. in : formData
  1264. type : string
  1265. required : true
  1266.  
  1267. - name : content
  1268. in : formData
  1269. type : string
  1270. required : true
  1271.  
  1272. - name : notification_url
  1273. in : formData
  1274. type : string
  1275. required : true
  1276.  
  1277. - name : app_uuid
  1278. in : path
  1279. type : string
  1280. required : true
  1281. description: The App uuid
  1282.  
  1283.  
  1284.  
  1285. tags:
  1286. - im
  1287.  
  1288. /im/{im_channel_uuid}/messages:
  1289. get:
  1290. description:
  1291. GET all channel messages
  1292. responses:
  1293. 200:
  1294. description: Success
  1295.  
  1296. parameters:
  1297. - name : Authorization
  1298. in : header
  1299. type : string
  1300. required : true
  1301. description: The session token that is got from init sequence
  1302.  
  1303.  
  1304. - name : im_channel_uuid
  1305. in : path
  1306. type : string
  1307. required : true
  1308.  
  1309.  
  1310. tags:
  1311. - im
  1312.  
  1313. /im/{im_channel_uuid}/search:
  1314. post:
  1315. description:
  1316. Search Messages
  1317. responses:
  1318. 200:
  1319. description: Success
  1320.  
  1321. parameters:
  1322. - name : Authorization
  1323. in : header
  1324. type : string
  1325. required : true
  1326. description: The session token that is got from init sequence
  1327.  
  1328.  
  1329. - name : im_channel_uuid
  1330. in : path
  1331. type : string
  1332. required : true
  1333.  
  1334. tags:
  1335. - im
  1336.  
  1337. /im/channel_message/{from_uuid}/{to_channel_uuid}:
  1338. post:
  1339. description:
  1340. Send Message to Channel
  1341. responses:
  1342. 200:
  1343. description: Success
  1344.  
  1345. parameters:
  1346. - name : Authorization
  1347. in : header
  1348. type : string
  1349. required : true
  1350. description: The session token that is got from init sequence
  1351.  
  1352.  
  1353. - name : body
  1354. in : formData
  1355. type : string
  1356. required : true
  1357.  
  1358. - name : content
  1359. in : formData
  1360. type : string
  1361. required : true
  1362.  
  1363. - name : notification_url
  1364. in : formData
  1365. type : string
  1366. required : true
  1367.  
  1368. - name : from_uuid
  1369. in : path
  1370. type : string
  1371. required : true
  1372.  
  1373. - name : to_channel_uuid
  1374. in : path
  1375. type : string
  1376. required : true
  1377.  
  1378.  
  1379. tags:
  1380. - im
  1381.  
  1382. /offline/message/{from_uuid}/{to_uuid}:
  1383. post:
  1384. description:
  1385. Send Message to Identity
  1386. responses:
  1387. 200:
  1388. description: Success
  1389.  
  1390. parameters:
  1391. - name : Authorization
  1392. in : header
  1393. type : string
  1394. required : true
  1395. description: The session token that is got from init sequence
  1396.  
  1397. - name : body
  1398. in : formData
  1399. type : string
  1400. required : true
  1401.  
  1402. - name : notification_url
  1403. in : formData
  1404. type : string
  1405. required : true
  1406.  
  1407. - name : from_uuid
  1408. in : path
  1409. type : string
  1410. required : true
  1411.  
  1412. - name : to_uuid
  1413. in : path
  1414. type : string
  1415. required : true
  1416.  
  1417.  
  1418. tags:
  1419. - im
  1420.  
  1421. /offline/message:
  1422. post:
  1423. description:
  1424. Send Message to Identity
  1425. responses:
  1426. 200:
  1427. description: Success
  1428.  
  1429. parameters:
  1430. - name : Authorization
  1431. in : header
  1432. type : string
  1433. required : true
  1434. description: The session token that is got from init sequence
  1435.  
  1436. - name : body
  1437. in : formData
  1438. type : string
  1439. required : true
  1440.  
  1441. - name : notification_url
  1442. in : formData
  1443. type : string
  1444. required : true
  1445.  
  1446. - name : from_uuid
  1447. in : formData
  1448. type : string
  1449. required : true
  1450.  
  1451. - name : to_uuid
  1452. in : formData
  1453. type : string
  1454. required : true
  1455.  
  1456. - name : type
  1457. in : formData
  1458. type : string
  1459. required : false
  1460.  
  1461.  
  1462. tags:
  1463. - im
  1464.  
  1465. /im/message:
  1466. post:
  1467. description:
  1468. Send Message to Identity
  1469. responses:
  1470. 200:
  1471. description: Success
  1472.  
  1473. parameters:
  1474. - name : Authorization
  1475. in : header
  1476. type : string
  1477. required : true
  1478. description: The session token that is got from init sequence
  1479.  
  1480. - name : body
  1481. in : formData
  1482. type : string
  1483. required : true
  1484.  
  1485. - name : notification_url
  1486. in : formData
  1487. type : string
  1488. required : true
  1489.  
  1490. - name : from_uuid
  1491. in : formData
  1492. type : string
  1493. required : true
  1494.  
  1495. - name : to_uuid
  1496. in : formData
  1497. type : string
  1498. required : true
  1499.  
  1500. - name : type
  1501. in : formData
  1502. type : string
  1503. required : false
  1504.  
  1505.  
  1506. tags:
  1507. - im
  1508.  
  1509. /im/message/{message_uuid}:
  1510. get:
  1511. description:
  1512. Get Message
  1513. responses:
  1514. 200:
  1515. description: Success
  1516.  
  1517. parameters:
  1518. - name : Authorization
  1519. in : header
  1520. type : string
  1521. required : true
  1522. description: The session token that is got from init sequence
  1523.  
  1524. - name : message_uuid
  1525. in : path
  1526. type : string
  1527. required : true
  1528.  
  1529.  
  1530.  
  1531. tags:
  1532. - im
  1533.  
  1534. /offline/unread_messages/{to_identity_uuid}:
  1535. get:
  1536. description:
  1537. Get Unread Messages to Identity
  1538. responses:
  1539. 200:
  1540. description: Success
  1541.  
  1542. parameters:
  1543. - name : Authorization
  1544. in : header
  1545. type : string
  1546. required : true
  1547. description: The session token that is got from init sequence
  1548.  
  1549. - name : to_identity_uuid
  1550. in : path
  1551. type : string
  1552. required : true
  1553.  
  1554.  
  1555.  
  1556. tags:
  1557. - im
  1558.  
  1559. /im/all_messages/{to_identity_uuid}:
  1560. get:
  1561. description:
  1562. Get All Messages to Identity
  1563. responses:
  1564. 200:
  1565. description: Success
  1566.  
  1567. parameters:
  1568. - name : Authorization
  1569. in : header
  1570. type : string
  1571. required : true
  1572. description: The session token that is got from init sequence
  1573.  
  1574. - name : to_identity_uuid
  1575. in : path
  1576. type : string
  1577. required : true
  1578.  
  1579.  
  1580. tags:
  1581. - im
  1582.  
  1583. /im/received/{message_uuid}/{receiver}:
  1584. post:
  1585. description:
  1586. Send Message Receipt
  1587. responses:
  1588. 200:
  1589. description: Success
  1590.  
  1591. parameters:
  1592. - name : Authorization
  1593. in : header
  1594. type : string
  1595. required : true
  1596. description: The session token that is got from init sequence
  1597.  
  1598. - name : message_uuid
  1599. in : path
  1600. type : string
  1601. required : true
  1602.  
  1603. - name : receiver
  1604. in : path
  1605. type : string
  1606. required : true
  1607.  
  1608.  
  1609. tags:
  1610. - im
  1611.  
  1612. /im/is_received/{message_uuid}/{receiver}:
  1613. get:
  1614. description:
  1615. Check Message Receipt
  1616. responses:
  1617. 200:
  1618. description: Success
  1619.  
  1620. parameters:
  1621. - name : Authorization
  1622. in : header
  1623. type : string
  1624. required : true
  1625. description: The session token that is got from init sequence
  1626.  
  1627. - name : message_uuid
  1628. in : path
  1629. type : string
  1630. required : true
  1631.  
  1632. - name : receiver
  1633. in : path
  1634. type : string
  1635. required : true
  1636.  
  1637. tags:
  1638. - im
  1639.  
  1640. /int/{from_identity_uuid}/identity/{to_identity_uuid}/allowed:
  1641. get:
  1642. description:
  1643. Identity Can Call Identity?
  1644. responses:
  1645. 200:
  1646. description: Success
  1647.  
  1648. parameters:
  1649. - name : Authorization
  1650. in : header
  1651. type : string
  1652. required : true
  1653. description: The session token that is got from init sequence
  1654.  
  1655. - name : from_identity_uuid
  1656. in : path
  1657. type : string
  1658. required : true
  1659.  
  1660. - name : to_identity_uuid
  1661. in : path
  1662. type : string
  1663. required : true
  1664.  
  1665. tags:
  1666. - identity
  1667.  
  1668. /identity/{identity_uuid}/call_report/{start_time}/{end_time}:
  1669. get:
  1670. description:
  1671. Get Identity Call Report
  1672. responses:
  1673. 200:
  1674. description: Success
  1675.  
  1676. parameters:
  1677. - name : Authorization
  1678. in : header
  1679. type : string
  1680. required : true
  1681. description: The session token that is got from init sequence
  1682.  
  1683. - name : identity_uuid
  1684. in : path
  1685. type : string
  1686. required : true
  1687. description: Number to get report
  1688.  
  1689. - name : start_time
  1690. in : path
  1691. type : string
  1692. required : true
  1693. description: Start of report
  1694.  
  1695. - name : end_time
  1696. in : path
  1697. type : string
  1698. required : true
  1699. description: End of report
  1700.  
  1701. tags:
  1702. - identity
  1703.  
  1704. /identity/{identity_uuid}/CDR/{start_time}/{end_time}:
  1705. get:
  1706. description:
  1707. Get CDR log
  1708. responses:
  1709. 200:
  1710. description: Success
  1711.  
  1712. parameters:
  1713. - name : Authorization
  1714. in : header
  1715. type : string
  1716. required : true
  1717. description: The session token that is got from init sequence
  1718.  
  1719. - name : identity_uuid
  1720. in : path
  1721. type : string
  1722. required : true
  1723. description: Number to get report
  1724.  
  1725. - name : start_time
  1726. in : path
  1727. type : string
  1728. required : true
  1729. description: Start of report
  1730.  
  1731. - name : end_time
  1732. in : path
  1733. type : string
  1734. required : true
  1735. description: End of report
  1736.  
  1737. tags:
  1738. - identity
  1739.  
  1740. /identity/{identity_uuid}/sms_log/{start_time}/{end_time}:
  1741. get:
  1742. description:
  1743. Get SMS log
  1744. responses:
  1745. 200:
  1746. description: Success
  1747.  
  1748. parameters:
  1749. - name : Authorization
  1750. in : header
  1751. type : string
  1752. required : true
  1753. description: The session token that is got from init sequence
  1754.  
  1755. - name : identity_uuid
  1756. in : path
  1757. type : string
  1758. required : true
  1759. description: Number to get report
  1760.  
  1761. - name : start_time
  1762. in : path
  1763. type : string
  1764. required : true
  1765. description: Start of report
  1766.  
  1767. - name : end_time
  1768. in : path
  1769. type : string
  1770. required : true
  1771. description: End of report
  1772.  
  1773. tags:
  1774. - identity
  1775.  
  1776. /action/{number}:
  1777. get:
  1778. description:
  1779. Get Action
  1780. responses:
  1781. 200:
  1782. description: Success
  1783.  
  1784. parameters:
  1785. - name : Authorization
  1786. in : header
  1787. type : string
  1788. required : true
  1789. description: The session token that is got from init sequence
  1790.  
  1791. - name : number
  1792. in : path
  1793. type : string
  1794. required : true
  1795. description: Number to get action (if no number, user/identity is used)
  1796.  
  1797. tags:
  1798. - voip_number
  1799.  
  1800. post:
  1801. description:
  1802. Set Action
  1803. responses:
  1804. 200:
  1805. description: Success
  1806.  
  1807. parameters:
  1808. - name : Authorization
  1809. in : header
  1810. type : string
  1811. required : true
  1812. description: The session token that is got from init sequence
  1813.  
  1814. - name : number
  1815. in : path
  1816. type : string
  1817. required : true
  1818. description: Number to get action (if no number, user is used)
  1819.  
  1820. - name : type
  1821. in : formData
  1822. type : string
  1823. required : true
  1824. description: The type action to set value (ivr/appuser/voicemail etc). For testing OptXML -> Freeswitch conversion(testing purposes), use "optxml" for type and send actual xml in param field
  1825.  
  1826. - name : param
  1827. in : formData
  1828. type : string
  1829. required : true
  1830. description: Target info for action, that is defined in type field (where to forward for ex)
  1831.  
  1832. - name : failover_action
  1833. in : formData
  1834. type : string
  1835. required : false
  1836. description: The failover_action to be done in case normal action is failed
  1837.  
  1838. - name : failover_param
  1839. in : formData
  1840. type : string
  1841. required : false
  1842. description: The parameter for failover_action, similar to param
  1843.  
  1844. - name : natural_text
  1845. in : formData
  1846. type : string
  1847. required : false
  1848. description: The text to be playen in TTS
  1849.  
  1850. tags:
  1851. - voip_number
  1852.  
  1853. /voip/{app_uuid}/countries:
  1854. get:
  1855. description:
  1856. Get List of supported countries for that App
  1857. responses:
  1858. 200:
  1859. description: Success
  1860.  
  1861. parameters:
  1862. - name : Authorization
  1863. in : header
  1864. type : string
  1865. required : true
  1866. description: The session token that is got from init sequence
  1867.  
  1868. - name : app_uuid
  1869. in : path
  1870. type : string
  1871. required : true
  1872. description: App uuid
  1873.  
  1874. tags:
  1875. - voip_number
  1876.  
  1877. /voip/all_countries:
  1878. get:
  1879. description:
  1880. Get List of all supported countries in Opentact
  1881. responses:
  1882. 200:
  1883. description: Success
  1884.  
  1885. parameters:
  1886. - name : Authorization
  1887. in : header
  1888. type : string
  1889. required : true
  1890. description: The session token that is got from init sequence
  1891.  
  1892. tags:
  1893. - voip_number
  1894.  
  1895.  
  1896. /voip/all_states:
  1897. get:
  1898. description:
  1899. Get List of all supported states in Opentact
  1900. responses:
  1901. 200:
  1902. description: Success
  1903.  
  1904. parameters:
  1905. - name : Authorization
  1906. in : header
  1907. type : string
  1908. required : true
  1909. description: The session token that is got from init sequence
  1910.  
  1911. tags:
  1912. - voip_number
  1913.  
  1914.  
  1915. /voip/all_states/{country}:
  1916. get:
  1917. description:
  1918. Get List of all supported states in Opentact
  1919. responses:
  1920. 200:
  1921. description: Success
  1922.  
  1923. parameters:
  1924. - name : Authorization
  1925. in : header
  1926. type : string
  1927. required : true
  1928. description: The session token that is got from init sequence
  1929.  
  1930. - name : country
  1931. in : path
  1932. type : string
  1933. required : true
  1934.  
  1935. tags:
  1936. - voip_number
  1937.  
  1938.  
  1939.  
  1940. /voip/{app_uuid}/plan_info/{plan_id}:
  1941. get:
  1942. description:
  1943. "Get Country/Plan Info (Details of a plan is acquired by this command)"
  1944. responses:
  1945. 200:
  1946. description: Success
  1947.  
  1948. parameters:
  1949. - name : Authorization
  1950. in : header
  1951. type : string
  1952. required : true
  1953. description: The session token that is got from init sequence
  1954.  
  1955. - name : app_uuid
  1956. in : path
  1957. type : string
  1958. required : true
  1959. description: App uuid
  1960.  
  1961. - name : plan_id
  1962. in : path
  1963. type : string
  1964. required : true
  1965. description: This is plan id, that listed in country info
  1966.  
  1967. tags:
  1968. - voip_number
  1969.  
  1970. /voip/{app_uuid}/order_number:
  1971. post:
  1972. description:
  1973. Place an order for a number (Order A Number)
  1974. responses:
  1975. 200:
  1976. description: Success
  1977.  
  1978. parameters:
  1979. - name : Authorization
  1980. in : header
  1981. type : string
  1982. required : true
  1983. description: The session token that is got from init sequence
  1984.  
  1985. - name : app_uuid
  1986. in : path
  1987. type : string
  1988. required : true
  1989. description: App uuid
  1990.  
  1991. - name : app_token
  1992. in : formData
  1993. type : string
  1994. required : true
  1995. description: Token for App
  1996.  
  1997. - name : country_iso
  1998. in : formData
  1999. type : string
  2000. required : true
  2001. description: The abbreviation of Country
  2002.  
  2003. - name : state
  2004. in : formData
  2005. type : string
  2006. required : true
  2007. description: State info
  2008.  
  2009. - name : number
  2010. in : formData
  2011. type : string
  2012. required : true
  2013. description: Number to order
  2014.  
  2015. - name : description
  2016. in : formData
  2017. type : string
  2018. required : false
  2019. description: Description
  2020.  
  2021. - name : transaction_id
  2022. in : formData
  2023. type : string
  2024. required : false
  2025. description: The transaction_id that is got from payment gateway, such as paypal
  2026.  
  2027. tags:
  2028. - voip_number
  2029.  
  2030. /voip/{app_uuid}/number:
  2031. delete:
  2032. description:
  2033. Cancel order
  2034. responses:
  2035. 200:
  2036. description: Success
  2037.  
  2038. parameters:
  2039. - name : Authorization
  2040. in : header
  2041. type : string
  2042. required : true
  2043. description: The session token that is got from init sequence
  2044.  
  2045. - name : app_uuid
  2046. in : path
  2047. type : string
  2048. required : true
  2049. description: App uuid
  2050.  
  2051. - name : number
  2052. in : formData
  2053. type : string
  2054. required : true
  2055. description: Number to cancel
  2056.  
  2057. tags:
  2058. - voip_number
  2059.  
  2060. /voip/{app_uuid}/check_number:
  2061. post:
  2062. description:
  2063. Check Number Availability
  2064. responses:
  2065. 200:
  2066. description: Success
  2067.  
  2068. parameters:
  2069. - name : Authorization
  2070. in : header
  2071. type : string
  2072. required : true
  2073. description: The session token that is got from init sequence
  2074.  
  2075. - name : app_uuid
  2076. in : path
  2077. type : string
  2078. required : true
  2079. description: App uuid
  2080.  
  2081. - name : app_token
  2082. in : formData
  2083. type : string
  2084. required : true
  2085. description: Token of App
  2086.  
  2087. - name : country_iso
  2088. in : formData
  2089. type : string
  2090. required : true
  2091.  
  2092. - name : state
  2093. in : formData
  2094. type : string
  2095. required : true
  2096.  
  2097. - name : number
  2098. in : formData
  2099. type : string
  2100. required : true
  2101.  
  2102. tags:
  2103. - voip_number
  2104.  
  2105. /voip/{app_uuid}/reserve_number:
  2106. post:
  2107. description:
  2108. Reserve A Number
  2109. responses:
  2110. 200:
  2111. description: Success
  2112.  
  2113. parameters:
  2114. - name : Authorization
  2115. in : header
  2116. type : string
  2117. required : true
  2118. description: The session token that is got from init sequence
  2119.  
  2120. - name : app_uuid
  2121. in : path
  2122. type : string
  2123. required : true
  2124. description: App uuid
  2125.  
  2126. - name : app_token
  2127. in : formData
  2128. type : string
  2129. required : true
  2130.  
  2131. - name : country_iso
  2132. in : formData
  2133. type : string
  2134. required : true
  2135.  
  2136. - name : state
  2137. in : formData
  2138. type : string
  2139. required : true
  2140.  
  2141. - name : number
  2142. in : formData
  2143. type : string
  2144. required : true
  2145.  
  2146. - name : description
  2147. in : formData
  2148. type : string
  2149. required : true
  2150.  
  2151. tags:
  2152. - voip_number
  2153.  
  2154. /app/{app_uuid}/services:
  2155. get:
  2156. description:
  2157. Get My services
  2158. responses:
  2159. 200:
  2160. description: Success
  2161.  
  2162. parameters:
  2163. - name : Authorization
  2164. in : header
  2165. type : string
  2166. required : true
  2167. description: The session token that is got from init sequence
  2168.  
  2169. - name : app_uuid
  2170. in : path
  2171. type : string
  2172. required : true
  2173. description: App uuid
  2174.  
  2175. tags:
  2176. - app
  2177.  
  2178. /int/dev/{dev_uuid}/balance:
  2179. get:
  2180. description:
  2181. Get Balance
  2182. responses:
  2183. 200:
  2184. description: Success
  2185.  
  2186. parameters:
  2187. - name : Authorization
  2188. in : header
  2189. type : string
  2190. required : true
  2191. description: The session token that is got from init sequence
  2192. - name : dev_uuid
  2193.  
  2194. in : path
  2195. type : string
  2196. required : true
  2197. description: The dev uuid
  2198.  
  2199. tags:
  2200. - dev
  2201.  
  2202. /int/dev/{dev_uuid}/payments:
  2203. get:
  2204. description:
  2205. Get My payments
  2206. responses:
  2207. 200:
  2208. description: Success
  2209.  
  2210. parameters:
  2211. - name : Authorization
  2212. in : header
  2213. type : string
  2214. required : true
  2215. description: The session token that is got from init sequence
  2216.  
  2217. - name : dev_uuid
  2218. in : path
  2219. type : string
  2220. required : true
  2221. description: The Dev uuid
  2222.  
  2223. tags:
  2224. - dev
  2225.  
  2226.  
  2227. /int/dev/forget:
  2228. post:
  2229. description:
  2230. Send forget pass email to developer
  2231.  
  2232. responses:
  2233. 200:
  2234. description: Success
  2235.  
  2236. parameters:
  2237. - name: user_name
  2238. in : formData
  2239. type : string
  2240. description: developer user_name
  2241.  
  2242. /int/dev/forget_verify:
  2243. post:
  2244. description:
  2245. Verify forget email hash
  2246.  
  2247. responses:
  2248. 200:
  2249. description: Success
  2250.  
  2251. parameters:
  2252. - name: user_name
  2253. in : formData
  2254. type : string
  2255. description: developer user_name
  2256.  
  2257. - name: hash
  2258. in : formData
  2259. type : string
  2260. description: the hash value got from user's email link
  2261.  
  2262.  
  2263.  
  2264. /ui/issue_payment:
  2265. post:
  2266. description:
  2267. Add Payment
  2268. responses:
  2269. 200:
  2270. description: Success
  2271.  
  2272. parameters:
  2273. - name : dev_uuid
  2274. in : formData
  2275. type : string
  2276. required : true
  2277. description: Developer UUID
  2278.  
  2279.  
  2280. - name : amount
  2281. in : formData
  2282. type : string
  2283. required : true
  2284. description: Amount of Payment
  2285.  
  2286.  
  2287. - name : currency
  2288. in : formData
  2289. type : string
  2290. required : true
  2291. description: Currency of Payment
  2292.  
  2293. - name : transaction_id
  2294. in : formData
  2295. type : string
  2296. required : false
  2297. description: transaction_id that is got from paypal etc..payment gateway.. for cross reference
  2298.  
  2299.  
  2300. tags:
  2301. - dev
  2302.  
  2303. /im/{app_uuid}/messages/{start_time}/{end_time}:
  2304. get:
  2305. description:
  2306. Get Chat Messages
  2307. responses:
  2308. 200:
  2309. description: Success
  2310.  
  2311. parameters:
  2312. - name : app_uuid
  2313. in : path
  2314. type : string
  2315. required : true
  2316. description: The App uuid
  2317.  
  2318.  
  2319. - name : start_time
  2320. in : path
  2321. type : string
  2322. required : true
  2323. description: Start time of action
  2324.  
  2325. - name : end_time
  2326. in : path
  2327. type : string
  2328. required : true
  2329. description: Start time of action
  2330.  
  2331. tags:
  2332. - im
  2333.  
  2334. /int/dev/{dev_uuid}:
  2335. get:
  2336. description:
  2337. Get Developer Status/Info
  2338. responses:
  2339. 200:
  2340. description: Success
  2341.  
  2342. parameters:
  2343. - name : dev_uuid
  2344. in : path
  2345. type : string
  2346. required : true
  2347. description: Developer UUID
  2348.  
  2349. tags:
  2350. - dev
  2351.  
  2352. /ui/{app_uuid}/IncomingCDR/{start_time}/{end_time}:
  2353. get:
  2354. description:
  2355. Get Incoming CDR
  2356. responses:
  2357. 200:
  2358. description: Success
  2359.  
  2360. parameters:
  2361. - name : app_uuid
  2362. in : path
  2363. type : string
  2364. required : true
  2365. description: The App uuid
  2366.  
  2367.  
  2368. - name : start_time
  2369. in : path
  2370. type : string
  2371. required : true
  2372. description: Start time of action
  2373.  
  2374.  
  2375. - name : end_time
  2376. in : path
  2377. type : string
  2378. required : true
  2379. description: Start time of action
  2380.  
  2381. tags:
  2382. - ui
  2383.  
  2384. /ui/{app_uuid}/IncomingCallUsage/{date}:
  2385. get:
  2386. description:
  2387. Get Incoming Call Usage
  2388. responses:
  2389. 200:
  2390. description: Success
  2391.  
  2392. parameters:
  2393. - name : app_uuid
  2394. in : path
  2395. type : string
  2396. required : true
  2397. description: The App uuid
  2398.  
  2399.  
  2400. - name : date
  2401. in : path
  2402. type : string
  2403. required : true
  2404. description: Date
  2405.  
  2406. tags:
  2407. - ui
  2408.  
  2409. /ui/{app_uuid}/OutgoingCDR/{start_time}/{end_time}:
  2410. get:
  2411. description:
  2412. Get Outgoing CDR
  2413. responses:
  2414. 200:
  2415. description: Success
  2416.  
  2417. parameters:
  2418. - name : app_uuid
  2419. in : path
  2420. type : string
  2421. required : true
  2422. description: The App uuid
  2423.  
  2424.  
  2425. - name : start_time
  2426. in : path
  2427. type : string
  2428. required : true
  2429. description: Start time of action
  2430.  
  2431.  
  2432. - name : end_time
  2433. in : path
  2434. type : string
  2435. required : true
  2436. description: Start time of action
  2437.  
  2438. tags:
  2439. - ui
  2440.  
  2441. /ui/{app_uuid}/outgoingCallUsage/{date}:
  2442. get:
  2443. description:
  2444. Get Outgoing Call Usage
  2445. responses:
  2446. 200:
  2447. description: Success
  2448.  
  2449. parameters:
  2450. - name : app_uuid
  2451. in : path
  2452. type : string
  2453. required : true
  2454. description: The App uuid
  2455.  
  2456.  
  2457. - name : date
  2458. in : path
  2459. type : string
  2460. required : true
  2461. description: Date
  2462.  
  2463.  
  2464. tags:
  2465. - ui
  2466.  
  2467. /ui/{app_uuid}/P2PCDR/{start_time}/{end_time}:
  2468. get:
  2469. description:
  2470. Get P2P CDR (FROM identity to identity)
  2471. responses:
  2472. 200:
  2473. description: Success
  2474.  
  2475. parameters:
  2476. - name : app_uuid
  2477. in : path
  2478. type : string
  2479. required : true
  2480. description: The App uuid
  2481.  
  2482. - name : start_time
  2483. in : path
  2484. type : string
  2485. required : true
  2486. description: Start time of action (Time format 2017-04-07_12:00:00)
  2487.  
  2488. - name : end_time
  2489. in : path
  2490. type : string
  2491. required : true
  2492. description: Start time of action
  2493.  
  2494. tags:
  2495. - ui
  2496.  
  2497. /ui/P2PCDR/{from_identity_uuid}/{to_identity_uuid}:
  2498. get:
  2499. description:
  2500. Get P2P CDR (FROM identity to identity)
  2501. responses:
  2502. 200:
  2503. description: Success
  2504.  
  2505. parameters:
  2506. - name : from_identity_uuid
  2507. in : path
  2508. type : string
  2509. required : true
  2510. description: Start time of action
  2511.  
  2512. - name : to_identity_uuid
  2513. in : path
  2514. type : string
  2515. required : true
  2516. description: Start time of action
  2517.  
  2518.  
  2519. tags:
  2520. - ui
  2521.  
  2522. /ui/{app_uuid}/P2PCallUsage/{date}:
  2523. get:
  2524. description:
  2525. Get P2P Call Usage (Same as Incoming CDR ! just one day interval)
  2526. responses:
  2527. 200:
  2528. description: Success
  2529.  
  2530. parameters:
  2531. - name : app_uuid
  2532. in : path
  2533. type : string
  2534. required : true
  2535. description: The App uuid
  2536.  
  2537.  
  2538. - name : date
  2539. in : path
  2540. type : string
  2541. required : true
  2542. description: Date
  2543.  
  2544.  
  2545. tags:
  2546. - ui
  2547.  
  2548. /int/freeswitch/queue:
  2549. post:
  2550. description:
  2551. Add/create queue. Ret value is queue_uuid
  2552. responses:
  2553. 200:
  2554. description: Success
  2555.  
  2556. parameters:
  2557. - name : app_uuid
  2558. in : formData
  2559. type : string
  2560. required : true
  2561. description: this is a non-json form post.
  2562.  
  2563. parameters:
  2564. - name : background_audio
  2565. in : formData
  2566. type : string
  2567. required : false
  2568. description: this is a non-json form post.
  2569.  
  2570.  
  2571. tags:
  2572. - internal
  2573.  
  2574. patch:
  2575. description:
  2576. Patch queue.
  2577. responses:
  2578. 200:
  2579. description: Success
  2580.  
  2581. parameters:
  2582. - name : queue_uuid
  2583. in : formData
  2584. type : string
  2585. required : true
  2586. description: this is a non-json form post; uuid of queue to change
  2587.  
  2588. parameters:
  2589. - name : background_audio
  2590. in : formData
  2591. type : string
  2592. required : false
  2593. description: this is a non-json form post.
  2594.  
  2595.  
  2596. tags:
  2597. - internal
  2598.  
  2599. /int/freeswitch/queue/{queue_uuid}:
  2600. delete:
  2601. description:
  2602. Delete a queue
  2603. responses:
  2604. 200:
  2605. description: Success
  2606.  
  2607. parameters:
  2608. - name : queue_uuid
  2609. in : path
  2610. type : string
  2611. required : true
  2612.  
  2613.  
  2614. tags:
  2615. - internal
  2616.  
  2617. /app/{app_uuid}/queues:
  2618. get:
  2619. description:
  2620. Get Queues
  2621. responses:
  2622. 200:
  2623. description: Success
  2624.  
  2625. parameters:
  2626. - name : Authorization
  2627. in : header
  2628. type : string
  2629. required : true
  2630. description: The session token that is got from init sequence
  2631.  
  2632. - name : app_uuid
  2633. in : path
  2634. type : string
  2635. required : true
  2636. description: The App uuid
  2637.  
  2638. tags:
  2639. - app
  2640.  
  2641.  
  2642. /dashboard:
  2643. get:
  2644. description:
  2645. Dashboard (number of dev etc.)
  2646. responses:
  2647. 200:
  2648. description: Success
  2649.  
  2650. parameters:
  2651.  
  2652. - name : Authorization
  2653. in : header
  2654. type : string
  2655. required : true
  2656. description: The session token that is got from init sequence
  2657.  
  2658.  
  2659. tags:
  2660. - ui
  2661.  
  2662. /ui/login:
  2663. post:
  2664. description:
  2665. UI Login
  2666. responses:
  2667. 200:
  2668. description: Success
  2669.  
  2670. parameters:
  2671. - name : user_name
  2672. in : formData
  2673. type : string
  2674. required : true
  2675. description: User_name of developer
  2676.  
  2677.  
  2678. - name : password
  2679. in : formData
  2680. type : string
  2681. required : true
  2682.  
  2683. tags:
  2684. - ui
  2685.  
  2686. /ui/dev/register:
  2687. post:
  2688. description:
  2689. register (Developer)
  2690. responses:
  2691. 200:
  2692. description: Success
  2693.  
  2694. parameters:
  2695. - name : email
  2696. in : formData
  2697. type : string
  2698. required : false
  2699.  
  2700.  
  2701. - name : first_name
  2702. in : formData
  2703. type : string
  2704. required : false
  2705.  
  2706.  
  2707. - name : last_name
  2708. in : formData
  2709. type : string
  2710. required : false
  2711.  
  2712.  
  2713. - name : country
  2714. in : formData
  2715. type : string
  2716. required : false
  2717.  
  2718.  
  2719. - name : mobile_number
  2720. in : formData
  2721. type : string
  2722. required : false
  2723.  
  2724.  
  2725. - name : user_name
  2726. in : formData
  2727. type : string
  2728. required : true
  2729.  
  2730.  
  2731. - name : password
  2732. in : formData
  2733. type : string
  2734. required : true
  2735.  
  2736. tags:
  2737. - ui
  2738.  
  2739. /ui/dev/modify:
  2740. post:
  2741. description:
  2742. Developer Modify
  2743. responses:
  2744. 200:
  2745. description: Success
  2746.  
  2747. parameters:
  2748.  
  2749. - name : email
  2750. in : formData
  2751. type : string
  2752. required : false
  2753.  
  2754.  
  2755. - name : first_name
  2756. in : formData
  2757. type : string
  2758. required : false
  2759.  
  2760.  
  2761. - name : last_name
  2762. in : formData
  2763. type : string
  2764. required : false
  2765.  
  2766.  
  2767. - name : country
  2768. in : formData
  2769. type : string
  2770. required : false
  2771.  
  2772.  
  2773. - name : mobile_number
  2774. in : formData
  2775. type : string
  2776. required : false
  2777.  
  2778.  
  2779. - name : user_name
  2780. in : formData
  2781. type : string
  2782. required : false
  2783.  
  2784.  
  2785. - name : password
  2786. in : formData
  2787. type : string
  2788. required : false
  2789.  
  2790. - name : status
  2791. in : formData
  2792. type : string
  2793. required : false
  2794.  
  2795. tags:
  2796. - ui
  2797.  
  2798. /ui/dev/set_status:
  2799. post:
  2800. description:
  2801. Developer Set Status
  2802. responses:
  2803. 200:
  2804. description: Success
  2805.  
  2806. parameters:
  2807.  
  2808. - name : dev_uuid
  2809. in : formData
  2810. type : string
  2811. required : true
  2812.  
  2813.  
  2814. - name : status
  2815. in : formData
  2816. type : string
  2817. required : true
  2818.  
  2819.  
  2820.  
  2821. tags:
  2822. - ui
  2823.  
  2824. /ui/dev:
  2825. delete:
  2826. description:
  2827. Developer Delete
  2828. responses:
  2829. 200:
  2830. description: Success
  2831.  
  2832. parameters:
  2833.  
  2834. - name : dev_uuid
  2835. in : formData
  2836. type : string
  2837. required : true
  2838.  
  2839.  
  2840. tags:
  2841. - ui
  2842.  
  2843. /ui/dev/list/{from_row}/{to_row}:
  2844. post:
  2845. description:
  2846. List Developers
  2847. responses:
  2848. 200:
  2849. description: Success
  2850.  
  2851. parameters:
  2852. - name : from_row
  2853. in : path
  2854. type : string
  2855. required : true
  2856. description: Row
  2857.  
  2858.  
  2859. - name : to_row
  2860. in : path
  2861. type : string
  2862. required : true
  2863. description: Row
  2864.  
  2865.  
  2866. tags:
  2867. - ui
  2868.  
  2869. /dev/search:
  2870. post:
  2871. description:
  2872. Search Developers
  2873. responses:
  2874. 200:
  2875. description: Success
  2876.  
  2877. parameters:
  2878. - name : from
  2879. in : formData
  2880. type : string
  2881. required : false
  2882. description: Row
  2883.  
  2884. - name : to
  2885. in : formData
  2886. type : string
  2887. required : false
  2888. description: Row
  2889.  
  2890. - name : first_name
  2891. in : formData
  2892. type : string
  2893. required : false
  2894. description: Row
  2895.  
  2896. - name : last_name
  2897. in : formData
  2898. type : string
  2899. required : false
  2900. description: Row
  2901.  
  2902. - name : user_name
  2903. in : formData
  2904. type : string
  2905. required : false
  2906. description: Row
  2907.  
  2908. - name : email
  2909. in : formData
  2910. type : string
  2911. required : false
  2912. description: Row
  2913.  
  2914. - name : dev_uuid
  2915. in : formData
  2916. type : string
  2917. required : false
  2918. description: Row
  2919.  
  2920. - name : create_time
  2921. in : formData
  2922. type : string
  2923. required : false
  2924. description: Row
  2925.  
  2926. - name : status
  2927. in : formData
  2928. type : string
  2929. required : false
  2930. description: Row
  2931.  
  2932.  
  2933. tags:
  2934. - ui
  2935.  
  2936. /app/search:
  2937. post:
  2938. description:
  2939. Search Apps
  2940. responses:
  2941. 200:
  2942. description: Success
  2943.  
  2944. parameters:
  2945. - name : from
  2946. in : formData
  2947. type : string
  2948. required : false
  2949. description: Row
  2950.  
  2951. - name : to
  2952. in : formData
  2953. type : string
  2954. required : false
  2955. description: Row
  2956.  
  2957. - name : name
  2958. in : formData
  2959. type : string
  2960. required : false
  2961. description: Row
  2962.  
  2963. - name : description
  2964. in : formData
  2965. type : string
  2966. required : false
  2967. description: Row
  2968.  
  2969. - name : dev_uuid
  2970. in : formData
  2971. type : string
  2972. required : false
  2973. description: Row
  2974.  
  2975. - name : create_time
  2976. in : formData
  2977. type : string
  2978. required : false
  2979. description: Row
  2980.  
  2981. - name : status
  2982. in : formData
  2983. type : string
  2984. required : false
  2985. description: Row
  2986.  
  2987.  
  2988. tags:
  2989. - app
  2990.  
  2991. /identity/{from_identity}/follow/{target_identity}:
  2992. post:
  2993. description:
  2994. Request Follow for Identity
  2995. responses:
  2996. 200:
  2997. description: Success
  2998.  
  2999. parameters:
  3000. - name : Authorization
  3001. in : header
  3002. type : string
  3003. required : true
  3004. description: The session token that is got from init sequence
  3005.  
  3006. - name : from_identity
  3007. in : path
  3008. type : string
  3009. required : true
  3010.  
  3011. - name : target_identity
  3012. in : path
  3013. type : string
  3014. required : true
  3015.  
  3016. tags:
  3017. - identity
  3018.  
  3019.  
  3020. /identity/{target_identity}/accept/{from_identity}:
  3021. post:
  3022. description:
  3023. Accept Follow
  3024. responses:
  3025. 200:
  3026. description: Success
  3027.  
  3028. parameters:
  3029. - name : Authorization
  3030. in : header
  3031. type : string
  3032. required : true
  3033. description: The session token that is got from init sequence
  3034.  
  3035. - name : target_identity
  3036. in : path
  3037. type : string
  3038. required : true
  3039.  
  3040. - name : from_identity
  3041. in : path
  3042. type : string
  3043. required : true
  3044.  
  3045.  
  3046. tags:
  3047. - identity
  3048.  
  3049. /identity/{target_identity}/refuse/{from_identity}:
  3050. post:
  3051. description:
  3052. Refuse Follow
  3053. responses:
  3054. 200:
  3055. description: Success
  3056.  
  3057. parameters:
  3058. - name : Authorization
  3059. in : header
  3060. type : string
  3061. required : true
  3062. description: The session token that is got from init sequence
  3063.  
  3064.  
  3065. - name : target_identity
  3066. in : path
  3067. type : string
  3068. required : true
  3069.  
  3070.  
  3071. - name : from_identity
  3072. in : path
  3073. type : string
  3074. required : true
  3075.  
  3076.  
  3077. tags:
  3078. - identity
  3079.  
  3080. /identity/{target_identity}/block/{from_identity}:
  3081. post:
  3082. description:
  3083. Block Identity
  3084. responses:
  3085. 200:
  3086. description: Success
  3087.  
  3088. parameters:
  3089. - name : Authorization
  3090. in : header
  3091. type : string
  3092. required : true
  3093. description: The session token that is got from init sequence
  3094.  
  3095.  
  3096. - name : target_identity
  3097. in : path
  3098. type : string
  3099. required : true
  3100.  
  3101.  
  3102. - name : from_identity
  3103. in : path
  3104. type : string
  3105. required : true
  3106.  
  3107.  
  3108. tags:
  3109. - identity
  3110.  
  3111. /identity/{target_identity}/unfollow/{from_identity}:
  3112. post:
  3113. description:
  3114. UnFollow Identity
  3115. responses:
  3116. 200:
  3117. description: Success
  3118.  
  3119. parameters:
  3120. - name : Authorization
  3121. in : header
  3122. type : string
  3123. required : true
  3124. description: The session token that is got from init sequence
  3125.  
  3126.  
  3127. - name : target_identity
  3128. in : path
  3129. type : string
  3130. required : true
  3131.  
  3132.  
  3133. - name : from_identity
  3134. in : path
  3135. type : string
  3136. required : true
  3137.  
  3138. tags:
  3139. - identity
  3140.  
  3141. /identity/{from_identity}/follow_status/{target_identity}:
  3142. get:
  3143. description:
  3144. Check State of Follow
  3145. responses:
  3146. 200:
  3147. description: Success
  3148.  
  3149. parameters:
  3150. - name : Authorization
  3151. in : header
  3152. type : string
  3153. required : true
  3154. description: The session token that is got from init sequence
  3155.  
  3156.  
  3157. - name : from_identity
  3158. in : path
  3159. type : string
  3160. required : true
  3161.  
  3162.  
  3163. - name : target_identity
  3164. in : path
  3165. type : string
  3166. required : true
  3167.  
  3168.  
  3169. tags:
  3170. - identity
  3171.  
  3172. /identity/{from_identity}/notify/{target_identity}:
  3173. post:
  3174. description:
  3175. Track Identity changes
  3176. responses:
  3177. 200:
  3178. description: Success
  3179.  
  3180. parameters:
  3181. - name : Authorization
  3182. in : header
  3183. type : string
  3184. required : true
  3185. description: The session token that is got from init sequence
  3186.  
  3187.  
  3188. - name : notification_url
  3189. in : formData
  3190. type : string
  3191. required : true
  3192.  
  3193.  
  3194. - name : from_identity
  3195. in : path
  3196. type : string
  3197. required : true
  3198.  
  3199.  
  3200. - name : target_identity
  3201. in : path
  3202. type : string
  3203. required : true
  3204.  
  3205.  
  3206. tags:
  3207. - identity
  3208.  
  3209. /identity/{identity}/pending_followed:
  3210. get:
  3211. description:
  3212. get pending followed identities for the given identity; not accepted yet
  3213. responses:
  3214. 200:
  3215. description: Success
  3216.  
  3217. parameters:
  3218. - name : Authorization
  3219. in : header
  3220. type : string
  3221. required : true
  3222. description: The session token that is got from init sequence
  3223.  
  3224.  
  3225. - name : identity
  3226. in : path
  3227. type : string
  3228. required : true
  3229.  
  3230.  
  3231. tags:
  3232. - identity
  3233.  
  3234. /identity/{identity}/followers:
  3235. get:
  3236. description:
  3237. Get list of followers for the given identity
  3238. responses:
  3239. 200:
  3240. description: Success
  3241.  
  3242. parameters:
  3243. - name : Authorization
  3244. in : header
  3245. type : string
  3246. required : true
  3247. description: The session token that is got from init sequence
  3248.  
  3249.  
  3250. - name : identity
  3251. in : path
  3252. type : string
  3253. required : true
  3254.  
  3255.  
  3256. tags:
  3257. - identity
  3258.  
  3259. /int/freeswitch/get_action:
  3260. post:
  3261. description:
  3262. Freeswitch get_action (special for freeswitch, which requires post)
  3263. responses:
  3264. 200:
  3265. description: Success
  3266.  
  3267. parameters:
  3268. - name : number
  3269. in : formData
  3270. type : string
  3271. required : true
  3272.  
  3273. tags:
  3274. - internal
  3275.  
  3276.  
  3277. /int/freeswitch/dialplan:
  3278. post:
  3279. description:
  3280. Freeswitch get_action (special for freeswitch, which requires post) Same as get_action
  3281. responses:
  3282. 200:
  3283. description: Success
  3284.  
  3285. parameters:
  3286. - name : number
  3287. in : formData
  3288. type : string
  3289. required : true
  3290.  
  3291.  
  3292. tags:
  3293. - internal
  3294.  
  3295. /int/freeswitch/set_action:
  3296. post:
  3297. description:
  3298. Freeswitch set_action (This command, does not output anything.. as freeswitch commands are xml only)
  3299. responses:
  3300. 200:
  3301. description: Success
  3302.  
  3303. parameters:
  3304. - name : type
  3305. in : formData
  3306. type : string
  3307. required : true
  3308. description: ivr/http/redirect/voicemail etc..
  3309.  
  3310.  
  3311. - name : param
  3312. in : formData
  3313. type : string
  3314. required : true
  3315. description: parameter of action
  3316.  
  3317.  
  3318. - name : number
  3319. in : formData
  3320. type : string
  3321. required : true
  3322. description: (number or identity_uuid)
  3323.  
  3324.  
  3325. - name : failover_action
  3326. in : formData
  3327. type : string
  3328. required : false
  3329. description: action on failover
  3330.  
  3331.  
  3332. - name : failover_param
  3333. in : formData
  3334. type : string
  3335. required : false
  3336. description: parameter of failover action
  3337.  
  3338.  
  3339. - name : natural_text
  3340. in : formData
  3341. type : string
  3342. required : false
  3343. description: "Welcome... "
  3344.  
  3345.  
  3346. tags:
  3347. - internal
  3348.  
  3349. /ui/dev/{dev_uuid}/token:
  3350. post:
  3351. description:
  3352. UI Generate dev_token
  3353. responses:
  3354. 200:
  3355. description: Success
  3356.  
  3357. parameters:
  3358. - name : old_token
  3359. in : formData
  3360. type : string
  3361. required : true
  3362.  
  3363.  
  3364. - name : new_token
  3365. in : formData
  3366. type : string
  3367. required : true
  3368.  
  3369.  
  3370. - name : dev_uuid
  3371. in : path
  3372. type : string
  3373. required : true
  3374. description: Developer UUID
  3375.  
  3376. tags:
  3377. - ui
  3378.  
  3379.  
  3380. /ui/{app_uuid}/incoming_total_calls/{start_epoch}/{end_epoch}:
  3381. get:
  3382. description:
  3383. incoming_total_calls
  3384. responses:
  3385. 200:
  3386. description: Success
  3387.  
  3388. parameters:
  3389.  
  3390. - name : app_uuid
  3391. in : path
  3392. type : string
  3393. required : true
  3394. description: The App uuid
  3395.  
  3396.  
  3397. - name : start_epoch
  3398. in : path
  3399. type : string
  3400. required : true
  3401.  
  3402.  
  3403. - name : end_epoch
  3404. in : path
  3405. type : string
  3406. required : true
  3407.  
  3408.  
  3409. tags:
  3410. - ui
  3411.  
  3412. /ui/{app_uuid}/incoming_connected_calls/{start_epoch}/{end_epoch}:
  3413. get:
  3414. description:
  3415. incoming_connected_calls
  3416. responses:
  3417. 200:
  3418. description: Success
  3419.  
  3420. parameters:
  3421.  
  3422. - name : app_uuid
  3423. in : path
  3424. type : string
  3425. required : true
  3426. description: The App uuid
  3427.  
  3428.  
  3429. - name : start_epoch
  3430. in : path
  3431. type : string
  3432. required : true
  3433.  
  3434.  
  3435. - name : end_epoch
  3436. in : path
  3437. type : string
  3438. required : true
  3439.  
  3440. tags:
  3441. - ui
  3442.  
  3443. /ui/{app_uuid}/incoming_billed_time/{start_epoch}/{end_epoch}:
  3444. get:
  3445. description:
  3446. incoming_billed_time
  3447. responses:
  3448. 200:
  3449. description: Success
  3450.  
  3451. parameters:
  3452.  
  3453. - name : app_uuid
  3454. in : path
  3455. type : string
  3456. required : true
  3457. description: The App uuid
  3458.  
  3459.  
  3460. - name : start_epoch
  3461. in : path
  3462. type : string
  3463. required : true
  3464.  
  3465.  
  3466. - name : end_epoch
  3467. in : path
  3468. type : string
  3469. required : true
  3470.  
  3471.  
  3472. tags:
  3473. - ui
  3474.  
  3475. /ui/{app_uuid}/incoming_total_cost/{start_epoch}/{end_epoch}:
  3476. get:
  3477. description:
  3478. incoming_total_cost
  3479. responses:
  3480. 200:
  3481. description: Success
  3482.  
  3483. parameters:
  3484.  
  3485. - name : app_uuid
  3486. in : path
  3487. type : string
  3488. required : true
  3489. description: The App uuid
  3490.  
  3491.  
  3492. - name : start_epoch
  3493. in : path
  3494. type : string
  3495. required : true
  3496.  
  3497.  
  3498. - name : end_epoch
  3499. in : path
  3500. type : string
  3501. required : true
  3502.  
  3503.  
  3504. tags:
  3505. - ui
  3506.  
  3507. /ui/{app_uuid}/outgoing_total_calls/{start_epoch}/{end_epoch}:
  3508. get:
  3509. description:
  3510. outgoing_total_calls
  3511. responses:
  3512. 200:
  3513. description: Success
  3514.  
  3515. parameters:
  3516.  
  3517. - name : app_uuid
  3518. in : path
  3519. type : string
  3520. required : true
  3521. description: The App uuid
  3522.  
  3523.  
  3524. - name : start_epoch
  3525. in : path
  3526. type : string
  3527. required : true
  3528.  
  3529.  
  3530. - name : end_epoch
  3531. in : path
  3532. type : string
  3533. required : true
  3534.  
  3535.  
  3536. tags:
  3537. - ui
  3538.  
  3539. /ui/{app_uuid}/outgoing_connected_calls/{start_epoch}/{end_epoch}:
  3540. get:
  3541. description:
  3542. outgoing_connected_calls
  3543. responses:
  3544. 200:
  3545. description: Success
  3546.  
  3547. parameters:
  3548.  
  3549. - name : app_uuid
  3550. in : path
  3551. type : string
  3552. required : true
  3553. description: The App uuid
  3554.  
  3555.  
  3556. - name : start_epoch
  3557. in : path
  3558. type : string
  3559. required : true
  3560.  
  3561.  
  3562. - name : end_epoch
  3563. in : path
  3564. type : string
  3565. required : true
  3566.  
  3567.  
  3568. tags:
  3569. - ui
  3570.  
  3571. /ui/{app_uuid}/outgoing_billed_time/{start_epoch}/{end_epoch}:
  3572. get:
  3573. description:
  3574. outgoing_billed_time
  3575. responses:
  3576. 200:
  3577. description: Success
  3578.  
  3579. parameters:
  3580.  
  3581. - name : app_uuid
  3582. in : path
  3583. type : string
  3584. required : true
  3585. description: The App uuid
  3586.  
  3587.  
  3588. - name : start_epoch
  3589. in : path
  3590. type : string
  3591. required : true
  3592.  
  3593.  
  3594. - name : end_epoch
  3595. in : path
  3596. type : string
  3597. required : true
  3598.  
  3599.  
  3600. tags:
  3601. - ui
  3602.  
  3603. /ui/{app_uuid}/outgoing_total_cost/{start_epoch}/{end_epoch}:
  3604. get:
  3605. description:
  3606. outgoing_total_cost
  3607. responses:
  3608. 200:
  3609. description: Success
  3610.  
  3611. parameters:
  3612.  
  3613. - name : app_uuid
  3614. in : path
  3615. type : string
  3616. required : true
  3617. description: The App uuid
  3618.  
  3619.  
  3620. - name : start_epoch
  3621. in : path
  3622. type : string
  3623. required : true
  3624.  
  3625.  
  3626. - name : end_epoch
  3627. in : path
  3628. type : string
  3629. required : true
  3630.  
  3631.  
  3632. tags:
  3633. - ui
  3634.  
  3635. /identity/{identity_uuid}/device_info:
  3636. post:
  3637. description:
  3638. Set Device Info
  3639. responses:
  3640. 200:
  3641. description: Success
  3642.  
  3643. parameters:
  3644.  
  3645. - name : Authorization
  3646. in : header
  3647. type : string
  3648. required : true
  3649. description: The session token that is got from init sequence
  3650.  
  3651.  
  3652. - name : device_type
  3653. in : formData
  3654. type : string
  3655. required : true
  3656. description: ios/android/web etc.. (lower case)
  3657.  
  3658.  
  3659. - name : device_token
  3660. in : formData
  3661. type : string
  3662. required : true
  3663. description: The device_token, generally used in push notifications, such as Apple Push Notifications
  3664.  
  3665.  
  3666. - name : identity_uuid
  3667. in : path
  3668. type : string
  3669. required : true
  3670. description: Identity uuid to perfom action
  3671.  
  3672. tags:
  3673. - identity
  3674.  
  3675. /int/origination:
  3676. get:
  3677. description:
  3678. GET origination
  3679. responses:
  3680. 200:
  3681. description: Success
  3682.  
  3683. tags:
  3684. - internal
  3685.  
  3686. patch:
  3687. description:
  3688. SET origination
  3689. responses:
  3690. 200:
  3691. description: Success
  3692.  
  3693. parameters:
  3694.  
  3695. - name : rate
  3696. in : formData
  3697. type : string
  3698. required : true
  3699.  
  3700. - name : code
  3701. in : formData
  3702. type : string
  3703. required : true
  3704.  
  3705. tags:
  3706. - internal
  3707.  
  3708. /int/termination:
  3709. get:
  3710. description:
  3711. GET termination
  3712. responses:
  3713. 200:
  3714. description: Success
  3715.  
  3716. tags:
  3717. - internal
  3718.  
  3719. patch:
  3720. description:
  3721. SET termination
  3722. responses:
  3723. 200:
  3724. description: Success
  3725.  
  3726. parameters:
  3727.  
  3728. - name : rate
  3729. in : formData
  3730. type : string
  3731. required : true
  3732.  
  3733. - name : code
  3734. in : formData
  3735. type : string
  3736. required : true
  3737.  
  3738.  
  3739. tags:
  3740. - internal
  3741.  
  3742. /int/sms_rate:
  3743. get:
  3744. description:
  3745. GET termination
  3746. responses:
  3747. 200:
  3748. description: Success
  3749.  
  3750. tags:
  3751. - internal
  3752. - voip_number
  3753.  
  3754. patch:
  3755. description:
  3756. SET sms_rate
  3757. responses:
  3758. 200:
  3759. description: Success
  3760.  
  3761. parameters:
  3762.  
  3763. - name : sms_rate
  3764. in : formData
  3765. type : string
  3766. required : true
  3767.  
  3768. tags:
  3769. - internal
  3770. - voip_number
  3771.  
  3772. /int/email_template:
  3773. get:
  3774. description:
  3775. GET termination
  3776. responses:
  3777. 200:
  3778. description: Success
  3779.  
  3780. tags:
  3781. - internal
  3782.  
  3783.  
  3784. patch:
  3785. description:
  3786. SET sms_rate
  3787. responses:
  3788. 200:
  3789. description: Success
  3790.  
  3791. parameters:
  3792.  
  3793. - name : email_template
  3794. in : formData
  3795. type : string
  3796. required : true
  3797.  
  3798.  
  3799. tags:
  3800. - internal
  3801.  
  3802. /int/did_vendors:
  3803. get:
  3804. description:
  3805. List DID Vendors
  3806. responses:
  3807. 200:
  3808. description: Success
  3809.  
  3810. tags:
  3811. - internal
  3812.  
  3813. post:
  3814. description:
  3815. Insert DID Vendor
  3816. responses:
  3817. 200:
  3818. description: Success
  3819.  
  3820. parameters:
  3821.  
  3822. - name : code
  3823. in : formData
  3824. type : string
  3825. required : true
  3826.  
  3827.  
  3828. - name : country
  3829. in : formData
  3830. type : string
  3831. required : true
  3832.  
  3833.  
  3834. - name : area
  3835. in : formData
  3836. type : string
  3837. required : true
  3838.  
  3839.  
  3840. - name : rate
  3841. in : formData
  3842. type : string
  3843. required : true
  3844.  
  3845.  
  3846. - name : vendor
  3847. in : formData
  3848. type : string
  3849. required : true
  3850.  
  3851.  
  3852. - name : status
  3853. in : formData
  3854. type : string
  3855. required : true
  3856.  
  3857. tags:
  3858. - internal
  3859.  
  3860. /app/{app_uuid}/campaign:
  3861. post:
  3862. description:
  3863. Create Campaign
  3864. responses:
  3865. 200:
  3866. description: Success
  3867.  
  3868. parameters:
  3869.  
  3870. - name : Authorization
  3871. in : header
  3872. type : string
  3873. required : true
  3874. description: The session token that is got from init sequence
  3875.  
  3876.  
  3877. - name : app_uuid
  3878. in : path
  3879. type : string
  3880. required : true
  3881.  
  3882. - name : url
  3883. in : formData
  3884. type : string
  3885. required : false
  3886.  
  3887.  
  3888. - name : cdr_url
  3889. in : formData
  3890. type : string
  3891. required : false
  3892.  
  3893.  
  3894. - name : channels
  3895. in : formData
  3896. type : string
  3897. required : false
  3898.  
  3899.  
  3900. - name : action
  3901. in : formData
  3902. type : string
  3903. required : false
  3904.  
  3905.  
  3906. - name : sip_url
  3907. in : formData
  3908. type : string
  3909. required : false
  3910.  
  3911.  
  3912. - name : playback_url
  3913. in : formData
  3914. type : string
  3915. required : false
  3916.  
  3917.  
  3918. - name : queue
  3919. in : formData
  3920. type : string
  3921. required : false
  3922.  
  3923.  
  3924. - name : restful_api
  3925. in : formData
  3926. type : string
  3927. required : true
  3928.  
  3929.  
  3930. - name : caller_id
  3931. in : formData
  3932. type : string
  3933. required : true
  3934.  
  3935.  
  3936. - name : background_audio
  3937. in : formData
  3938. type : string
  3939. required : true
  3940.  
  3941. tags:
  3942. - app
  3943.  
  3944.  
  3945. patch:
  3946. description:
  3947. Patch Campaign
  3948. responses:
  3949. 200:
  3950. description: Success
  3951.  
  3952. parameters:
  3953.  
  3954. - name : Authorization
  3955. in : header
  3956. type : string
  3957. required : true
  3958. description: The session token that is got from init sequence
  3959.  
  3960.  
  3961. - name : app_uuid
  3962. in : path
  3963. type : string
  3964. required : true
  3965.  
  3966. - name : campaign_uuid
  3967. in : formData
  3968. type : string
  3969. required : true
  3970.  
  3971. - name : url
  3972. in : formData
  3973. type : string
  3974. required : false
  3975.  
  3976.  
  3977. - name : cdr_url
  3978. in : formData
  3979. type : string
  3980. required : false
  3981.  
  3982.  
  3983. - name : channels
  3984. in : formData
  3985. type : string
  3986. required : false
  3987.  
  3988.  
  3989. - name : action
  3990. in : formData
  3991. type : string
  3992. required : false
  3993.  
  3994.  
  3995. - name : sip_url
  3996. in : formData
  3997. type : string
  3998. required : false
  3999.  
  4000.  
  4001. - name : playback_url
  4002. in : formData
  4003. type : string
  4004. required : false
  4005.  
  4006.  
  4007. - name : queue
  4008. in : formData
  4009. type : string
  4010. required : false
  4011.  
  4012.  
  4013. - name : restful_api
  4014. in : formData
  4015. type : string
  4016. required : true
  4017.  
  4018.  
  4019. - name : caller_id
  4020. in : formData
  4021. type : string
  4022. required : true
  4023.  
  4024.  
  4025. - name : background_audio
  4026. in : formData
  4027. type : string
  4028. required : true
  4029.  
  4030. tags:
  4031. - app
  4032.  
  4033.  
  4034. /app/{app_uuid}/campaigns:
  4035. get:
  4036. description:
  4037. Get Campaigns
  4038. responses:
  4039. 200:
  4040. description: Success
  4041.  
  4042. parameters:
  4043.  
  4044. - name : Authorization
  4045. in : header
  4046. type : string
  4047. required : true
  4048. description: The session token that is got from init sequence
  4049.  
  4050.  
  4051. - name : app_uuid
  4052. in : path
  4053. type : string
  4054. required : true
  4055. description: The App uuid
  4056.  
  4057. tags:
  4058. - app
  4059.  
  4060. /campaign/{campaign_uuid}:
  4061. get:
  4062. description:
  4063. Get Campaign info
  4064. responses:
  4065. 200:
  4066. description: Success
  4067.  
  4068. parameters:
  4069.  
  4070. - name : Authorization
  4071. in : header
  4072. type : string
  4073. required : true
  4074. description: The session token that is got from init sequence
  4075.  
  4076.  
  4077. - name : campaign_uuid
  4078. in : path
  4079. type : string
  4080. required : true
  4081.  
  4082.  
  4083. tags:
  4084. - app
  4085.  
  4086. /campaign/add_numbers:
  4087. post:
  4088. description:
  4089. Add numbers to Campaign
  4090. responses:
  4091. 200:
  4092. description: Success
  4093.  
  4094. parameters:
  4095.  
  4096. - name : Authorization
  4097. in : header
  4098. type : string
  4099. required : true
  4100. description: The session token that is got from init sequence
  4101.  
  4102.  
  4103. - name : numbers
  4104. in : formData
  4105. type : string
  4106. required : true
  4107. description: Array of numbers like ["num1","num2"]
  4108.  
  4109. tags:
  4110. - app
  4111.  
  4112. /campaign/start:
  4113. post:
  4114. description:
  4115. Start a Campaign
  4116. responses:
  4117. 200:
  4118. description: Success
  4119.  
  4120. parameters:
  4121.  
  4122. - name : Authorization
  4123. in : header
  4124. type : string
  4125. required : true
  4126. description: The session token that is got from init sequence
  4127.  
  4128.  
  4129. - name : campaign_uuid
  4130. in : formData
  4131. type : string
  4132. required : true
  4133.  
  4134.  
  4135. tags:
  4136. - app
  4137.  
  4138. /campaign/stop:
  4139. post:
  4140. description:
  4141. Stop a Campaign
  4142. responses:
  4143. 200:
  4144. description: Success
  4145.  
  4146. parameters:
  4147.  
  4148. - name : Authorization
  4149. in : header
  4150. type : string
  4151. required : true
  4152. description: The session token that is got from init sequence
  4153.  
  4154.  
  4155. - name : campaign_uuid
  4156. in : formData
  4157. type : string
  4158. required : true
  4159.  
  4160.  
  4161.  
  4162. tags:
  4163. - app
  4164.  
  4165. /sms/send:
  4166. post:
  4167. description:
  4168. send sms
  4169. responses:
  4170. 200:
  4171. description: Success
  4172.  
  4173. parameters:
  4174.  
  4175. - name : Authorization
  4176. in : header
  4177. type : string
  4178. required : true
  4179. description: The session token that is got from init sequence
  4180.  
  4181.  
  4182. - name : from
  4183. in : formData
  4184. type : string
  4185. required : true
  4186.  
  4187.  
  4188. - name : to
  4189. in : formData
  4190. type : string
  4191. required : true
  4192.  
  4193.  
  4194. - name : message
  4195. in : formData
  4196. type : string
  4197. required : true
  4198.  
  4199. tags:
  4200. - voip_number
  4201.  
  4202. /edit_setup_fee:
  4203. post:
  4204. description:
  4205. Edit/add setup/mrc fee
  4206. responses:
  4207. 200:
  4208. description: Success
  4209.  
  4210. parameters:
  4211.  
  4212. - name : Authorization
  4213. in : header
  4214. type : string
  4215. required : true
  4216. description: The session token that is got from init sequence
  4217.  
  4218.  
  4219. - name : code
  4220. in : formData
  4221. type : string
  4222. required : true
  4223.  
  4224.  
  4225. - name : setup_fee
  4226. in : formData
  4227. type : string
  4228. required : false
  4229.  
  4230.  
  4231. - name : mrc
  4232. in : formData
  4233. type : string
  4234. required : false
  4235.  
  4236.  
  4237. - name : currency
  4238. in : formData
  4239. type : string
  4240. required : false
  4241.  
  4242. tags:
  4243. - voip_number
  4244. - internal
  4245.  
  4246. /voip/{app_uuid}/check_tfnumber:
  4247. post:
  4248. description:
  4249. Check/List Tollfree Numbers
  4250. responses:
  4251. 200:
  4252. description: Success
  4253.  
  4254. parameters:
  4255.  
  4256. - name : Authorization
  4257. in : header
  4258. type : string
  4259. required : true
  4260. description: The session token that is got from init sequence
  4261.  
  4262.  
  4263. - name : app_token
  4264. in : formData
  4265. type : string
  4266. required : true
  4267.  
  4268.  
  4269. - name : country_iso
  4270. in : formData
  4271. type : string
  4272. required : true
  4273.  
  4274.  
  4275. - name : state
  4276. in : formData
  4277. type : string
  4278. required : true
  4279.  
  4280.  
  4281. - name : number
  4282. in : formData
  4283. type : string
  4284. required : true
  4285.  
  4286.  
  4287. - name : app_uuid
  4288. in : path
  4289. type : string
  4290. required : true
  4291. description: The App uuid
  4292.  
  4293.  
  4294. tags:
  4295. - voip_number
  4296.  
  4297. /app/{app_uuid}/conference:
  4298. post:
  4299. description:
  4300. Create conference
  4301. responses:
  4302. 200:
  4303. description: Success
  4304.  
  4305. parameters:
  4306.  
  4307. - name : Authorization
  4308. in : header
  4309. type : string
  4310. required : true
  4311. description: The session token that is got from init sequence
  4312.  
  4313.  
  4314. - name : app_uuid
  4315. in : path
  4316. type : string
  4317. required : true
  4318. description: The App uuid
  4319.  
  4320. - name : pin
  4321. in : formData
  4322. type : string
  4323. required : false
  4324.  
  4325. tags:
  4326. - app
  4327.  
  4328.  
  4329. /app/{app_uuid}/conferences:
  4330. get:
  4331. description:
  4332. List conferences
  4333. responses:
  4334. 200:
  4335. description: Success
  4336.  
  4337. parameters:
  4338.  
  4339. - name : Authorization
  4340. in : header
  4341. type : string
  4342. required : true
  4343. description: The session token that is got from init sequence
  4344.  
  4345.  
  4346. - name : app_uuid
  4347. in : path
  4348. type : string
  4349. required : true
  4350. description: The App uuid
  4351.  
  4352.  
  4353. tags:
  4354. - app
  4355.  
  4356. /app/{app_uuid}/recordings:
  4357. get:
  4358. description:
  4359. List Recordings
  4360. responses:
  4361. 200:
  4362. description: Success
  4363.  
  4364. parameters:
  4365.  
  4366. - name : Authorization
  4367. in : header
  4368. type : string
  4369. required : true
  4370. description: The session token that is got from init sequence
  4371.  
  4372.  
  4373. - name : app_uuid
  4374. in : path
  4375. type : string
  4376. required : true
  4377. description: The App uuid
  4378.  
  4379. tags:
  4380. - app
  4381.  
  4382. /app/recording/{recording_uuid}:
  4383. get:
  4384. description:
  4385. Get Recording info
  4386. responses:
  4387. 200:
  4388. description: Success
  4389.  
  4390. parameters:
  4391.  
  4392. - name : Authorization
  4393. in : header
  4394. type : string
  4395. required : true
  4396. description: The session token that is got from init sequence
  4397.  
  4398.  
  4399. - name : recording_uuid
  4400. in : path
  4401. type : string
  4402. required : true
  4403.  
  4404. tags:
  4405. - app
  4406.  
  4407.  
  4408. /campaign/numbers:
  4409. delete:
  4410. description:
  4411. Delete numbers from campaign
  4412.  
  4413. responses:
  4414. 200:
  4415. description: Success
  4416.  
  4417. parameters:
  4418.  
  4419. - name : Authorization
  4420. in : header
  4421. type : string
  4422. required : true
  4423. description: The session token that is got from init sequence
  4424.  
  4425. - name : campaign_uuid
  4426. in : formData
  4427. type : string
  4428. required : true
  4429.  
  4430. - name : numbers
  4431. in : formData
  4432. type : string
  4433. required : true
  4434. description: Array of numbers like ["num1","num2"]
  4435.  
  4436. tags:
  4437. - app
  4438.  
  4439.  
  4440. /campaign/number:
  4441. patch:
  4442. description:
  4443. Patch number in campaign
  4444.  
  4445. responses:
  4446. 200:
  4447. description: Success
  4448.  
  4449. parameters:
  4450.  
  4451. - name : Authorization
  4452. in : header
  4453. type : string
  4454. required : true
  4455. description: The session token that is got from init sequence
  4456.  
  4457. - name : campaign_uuid
  4458. in : formData
  4459. type : string
  4460. required : true
  4461.  
  4462. - name : oldnumber
  4463. in : formData
  4464. type : string
  4465. required : true
  4466.  
  4467. - name : newnumber
  4468. in : formData
  4469. type : string
  4470. required : true
  4471.  
  4472.  
  4473. tags:
  4474. - app
  4475.  
  4476.  
  4477. /voip/country:
  4478. patch:
  4479. description:
  4480. Patch country info including per country sms
  4481.  
  4482. responses:
  4483. 200:
  4484. description: Success
  4485.  
  4486. parameters:
  4487.  
  4488. - name : Authorization
  4489. in : header
  4490. type : string
  4491. required : true
  4492. description: The session token that is got from init sequence
  4493.  
  4494. - name : id
  4495. in : formData
  4496. type : string
  4497. required : true
  4498.  
  4499. - name : carrier
  4500. in : formData
  4501. type : string
  4502. required : false
  4503.  
  4504.  
  4505. - name : country_name
  4506. in : formData
  4507. type : string
  4508. required : false
  4509.  
  4510. - name : state_name
  4511. in : formData
  4512. type : string
  4513. required : false
  4514.  
  4515. - name : country_iso
  4516. in : formData
  4517. type : string
  4518. required : false
  4519.  
  4520. - name : country_prefix
  4521. in : formData
  4522. type : string
  4523. required : false
  4524.  
  4525. - name :
  4526. in : feature_cost_plan_id
  4527. type : string
  4528. required : false
  4529.  
  4530. - name :
  4531. in : sms_rate
  4532. type : string
  4533. required : false
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!